CHAPTER 18: Documentation Comments

Previous

Java Language

Index

Next

18.1 The Text of a Documentation Comment

The text of a documentation comment consists of the characters between the /** that begins the comment and the */ that ends it. The text is divided into one or more lines. On each of these lines, leading * characters are ignored; for lines other than the first, blanks and tabs preceding the initial * characters are also discarded.

So, for example, in the comment:

/**XYZ
  ** Initialize to pre-trial defaults.
  123*/

the text of the comment has three lines. The first line consists of the text "XYZ "; the second line consists of the text " Initialize to pre-trial defaults. " and the third line consists of the text "123 "