Page 806 - Introduction to Programming with Java: A Problem Solving Approach

772 Appendix 6 Javadoc
Apago PDF Enhancer
Figure A6.1 Top part of javadoc output for Student class defined in Figure A5.1
information to be enclosed in a javadoc block comment that begins with a single forward slash followed by two asterisks and ends with a single asterisk followed by a single forward slash, like this:
/** <extractable-information> */
Since Figure A5.1 has an import statement between the general prologue and the class heading, we must move our general comment out of the general prologue and put it into a javadoc block comment located just above the class heading. Similarly, we must put individual constructor and method interface informa- tion into javadoc block comments located just above their respective headings. There is some flexibility. The extractable information in one of these javadoc block comments does not need to be on just one line. Also, if you wish, you may put the opening /** and the closing */ on lines above and below the text, as shown in Figure A6.2.