clipka wrote:
> Docman? Javadoc?

To clarify, I'm thinking maybe something more along the lines of the 
BON<->Eiffel equivalence, where something that looks like UML can be turned 
into source code and back again with the appropriate tool.

Something beyond the name of the function and the types of its arguments.

Plus, documentation that covers something besides the individual functions 
to be called, that covers what you cannot for now deduce from the source 
code itself.

I know javadoc (and similar) is supposed to cover that. In practice, it 
gives you a place to write that stuff down, but does nothing to make it 
useful to the author to do so. So documentation even of that type becomes a 
cost rather than a benefit.

How many projects have you seen with the doxygen or javadoc or whatever have 
either obvious cut-and-paste errors or no documentation beyond what you can 
gleen from the source at all?

-- 
   Darren New, San Diego CA, USA (PST)
   I ordered stamps from Zazzle that read "Place Stamp Here".

Post a reply to this message