Overview of supported JavaDoc style tags

The main motivation for us supporting the JavaDoc syntax is because many developers use multiple languages, and we assume that developers would like to use the same DocComment syntax everywhere.
Since JavaDoc probably is the most well-known DocComment standard, we decided to support it's syntax. (The syntax itself also is quite nice as well as being compatible with the DocComments supported in Time2HELP Build 33 and earlier).

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.

An @-tag must start on a separate line, and continues until the end of the comment or the next @-tag starts, click here to see an example of use, or look at the example in the @enum tag.

"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))

"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.

HTML generated by Time2HELP