The tool is a text editor ;-) If we agree on my suggestions, we can compose a set of guidelines to arrive at deliverables that comply with them.
One tool could be a template and a checklist to help the writer of the documentation. -- Cesar Rabak Em 25/04/2011 14:59, Alexandre Bergel < [email protected] > escreveu: 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, [email protected] 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 ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.
