Overview of supported JavaDoc style tags

Sun's JavaDoc home page can be found at: http://java.sun.com/j2se/javadoc

In order to not force Java vocabulary upon the innocent Delphi developer, we allow "synonyms" for some of the tags.

"Core" tags

The "core" tags are the ones being directly adapted from JavaDoc

(The JavaDoc @see tag isn't supported yet. We're discussing whether we should "split it up" into @seeClass, @seeUnit, @seeRoutine etc. (Java doesn't have free-standing routines, global variables, constants, record types etc, everything must be wrapped into classes))

• @Author names the author of the artifact/item.
• @Deprecated for specifying that an item has been deprecated ("retired").
• @Param tag for documenting parameters
• @raises documents an exception which may be raised by a method/routine/property.
• @Returns tag for documenting result/return value

"Extended" tags

The "extended" tags are tags not found in JavaSoft's JavaDoc tool, they have been introduced because we find them highly useful.

Some of these tags were (as far as we know) first presented in the article " AmbySoft Inc. Java Coding Standards", by Scott W. Ambler. Even if you have no intention of ever learning/using Java, you would likely benefit from reading this document , as much of it is relevant to Delphi as well. We may add support for more of the tags suggested in this article.

• @Bug describes a known bug.
• @Category marks that a class is a member of a given category.
• @Component marks that a class is to be listed as a component.
• @CPP adds a C++ declaration to the output.
• @Desc provides a description of an item
• @Enum describes an identifier in an enumerated type
• @Event marks that a property is to be considered an event
• @Example provides an example of how to use the item.
• @Exclude marks that an item to be excluded from the output
• @SeeAlso adds an entry containing "free form" text to the See Also section
• @Todo marks that the item isn't finished yet
• @Precondition documents a precondition
• @Postcondition documents a postcondition
• @Summary provides a short description of an item