On Sat, 2002-10-05 at 09:53, Bjorn Reese wrote: > As much documentation as possible should be written within the > program to reduce the possibility of the code and the documentation > getting out of sync. Such information should be extractable to > external documents by use of JavaDoc or similar.
Very definitely. The only problem I have is that I want ot put UML diagrams into the documentation but none of the tools I have found provide an easy way of doing this sensibly. I guess what is needed is for javadoc, doxygen etc. to provide a notation (LaTeX style I guess) for describing UML diagrams. > Having worked on several projects where the original developers > thought that comments were a waste of time, I can assure you that > they are not. Even the fatuous comments turn out to be useful since they indicate that the author of the comments is a cretin and their code is not to be trusted :-) -- Russel. ==================================================================== Dr Russel Winder Chief Technology Officer OneEighty Software Ltd Tel: +44 20 8680 8712 Cygnet House Fax: +44 20 8680 8453 12-14 Sydenham Road [EMAIL PROTECTED] Croydon, Surrey CR9 2ET, UK http://www.180sw.com ==================================================================== Under the Regulation of Investigatory Powers (RIP) Act 2000 together with any and all Regulations in force pursuant to the Act One Eighty Software Ltd reserves the right to monitor any or all incoming or outgoing communications as provided for under the Act
signature.asc
Description: This is a digitally signed message part
