Re: EPICS source Documentation

[Kay-Uwe Kasemir <kasemirk@ornl.gov>]

On Sep 8, 2006, at 12:20 , David Dudley wrote:
> Just a strange question,
Quite a provocative question, but just about right for a Friday flame  
war ;-)

> but I've noticed a tendency of all the source files to not have any  
> comments (or very few) in them regarding what they do.
The EPICS sources all come from different people.
Some of the newer sources, especially those meant to be used by others,
actually have nice comments, like osiTime.h.
I think that's also because newer IDEs for C++ or especially Java
help a lot with the source code generation and navigation,
and systems like doxygen or javadoc turn comments into neat
API descriptions, so people who've used them now tend to
add more comments.
On the other hand, some of the older EPICS sources show the
heritage of being created with vi on serial line terminals,
where every typed character was carefully reconsidered,
and comments where considered harmful to the readability
of your code.

-Kay