On 20/6/14 09:10, kilon alios wrote:
I completely understand the inability to create full blown
documentation because of lack of free time. I am not referring to any
Pharo Library out there.
Please pharo developers comment your classes.
+10000000
Dont even comment the small ones, comment the big ones (over 20
methods). 5 minutes per class , is 150 words (assuming you are a slow
30 words/per minute , 3 times more if you type fast). Just a class
comment, I can live without method comments. 15 lines, enough to
provide valuable information to your users.
Even for very big libraries like Spec it should not take more than 10
key classes to be documented this way , no more than 1 hour total of
documentation for a project that can take months of coding to
complete. It can't be this hard.
Saying that I will start adding class comments wherever I can but
obviously the people that have created the code are far more qualified
than me .
Have a nice day :)