JavaDoc: where to add notes/remarks to documentation?

Question

When coding in C# I have always found the tag remarks very useful for providing notes about the implementation of a class or method, or to give information about th

Answer 1

You can create your own custom tags too.

Here is a javadoc comment that includes the custom tag "@note":

    /**
     * Quark represents a quark.
     *
     * @note If you spin a quark, it will spin forever!
     */
    public class Quark {

    }

To generate javadocs for the above, run javadoc like this:

javadoc -tag note:a:"Note:" Quark.java

Source: http://www.developer.com/java/other/article.php/3085991/Javadoc-Programming.htm