How to write javadoc comments properly?

Vitezslav Stejskal <[email protected]> Wed, 07 May 2003 13:59:41 +0200
Newsgroups gmane.comp.java.netbeans.modules.projects.devel
Message-ID <[email protected]>
Dear Developers,

when reviewing some our javadoc comments (mostly in projects and java 
related modules) I found that sometimes we violate rules for writing 
correct javadoc comments. Since the documentation is important part of 
every API I would like to encourage everybody to read javadoc-style 
guidelines on http://java.sun.com/j2se/javadoc/ and write javadoc 
comments properly. Specifically, read the section 'A Style Guide' of 
following document 
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html. Another 
useful reading is here 
http://java.sun.com/j2se/javadoc/writingapispecs/index.html.

Looking forward a lot of nice javadocs ;-).

Thanks,
-vita