How do I write Javadoc doc comments and tags?
To get details on how to write Javadoc tags and documentation comments, this is the best place at Sun to start: • How to Write Doc Comments for Javadoc describes the tag conventions we follow at Java Software. Example takes you directly to the first example in this document. If your doc comments comprise an API specification, you might find this document useful: • Requirements for Writing API Specifications – Standard requirements used when writing the Java 2 Platform Specification. It can be useful whether you are writing API specifications in source file documentation comments or in other formats. It covers requirements for packages, classes, interfaces, fields and methods to satisfy testable assertions.
How do I write Javadoc doc comments and tags?