Ian Clarke wrote:
> 
> You can now find automatically updated JavaDocs of the Freenet server
> and command-line clients online (see JavaDocs link in development
> section of menu, or go straight to http://freenet.sourceforge.net/jdoc/
> ).

On this subject, since our commenting ability is now on-show to
joe-public, can we try to follow best practice with commenting?  I know
it is boring, but we now have quite a few developers, and there are
numerous parts of the code that even I don't understand!  There is also
the issue of others hoping to reimplement the node in other languages,
and to them well commented javadocs will be an invaluable tool.

My advice is to comment a method *before* you write it, since this will
help keep the purpose of what you are doing clear in your head.

We should also try to retro-comment the rest of the code, many areas are
decidedly lacking in javadocs.

I know I am guilty as the next guy for not commenting stuff, but there
is no time like the present to set a precedent.

Ian.

_______________________________________________
Freenet-dev mailing list
Freenet-dev at lists.sourceforge.net
http://lists.sourceforge.net/mailman/listinfo/freenet-dev

Reply via email to