[Pharo-project] What is a well documented class?

Alexandre Bergel alexandre.bergel at me.com
Mon Apr 25 19:59:43 CEST 2011


Ok, but what would be a tool that help you write comment? This cannot be the system browser.

Alexandre


On 25 Apr 2011, at 12:37, csrabak at bol.com.br wrote:

> I think a well documented class is a class which can be understood by reading its documentation without having to resort to anything else, be it running the test only to see something not obvious, reading the code to understand the working which the document fell short; and without having to assemble a mini encyclopedia of references in order to grasp the contents of the documentation.
> 
> my 0.019999
> 
> --
> Cesar Rabak 
> 

-- 
_,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:
Alexandre Bergel  http://www.bergel.eu
^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.








More information about the Pharo-project mailing list