james-server-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Danny Angus" <da...@apache.org>
Subject RE: [PATCH] NNTP Server fixes
Date Wed, 02 Oct 2002 08:40:50 GMT
> A comment like '// see section <...>' is far more
> helpful to
> me than say javadoc style comments on a private variable.

IMHO I'd agree that javadocs should only be used on public and package scope
methods and fields.
Private fields and methods need only be commented, and privately, where
their use is not clear from the code.

I subscribe to the XP view that a requirement for extensive commenting of
sources is in avoidance of writing clear code.
Obviously this has to be tempered, in a OS project particularly, with the
need to make the code accessable to any would be developer, and frankly I
think James own code is not the inscrutable part of this, the steep learning
curve for interested participants is James use of Avalon in all its guises.


To unsubscribe, e-mail:   <mailto:james-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:james-dev-help@jakarta.apache.org>

View raw message