java关键词 英文原文解释,javadoc注释规范(国外英文资料).doc

javadoc注释规范(国外英文资料)

javadoc注释规范(国外英文资料)

Does Javadoc make notes?

I. Java documents?

Notes a / /?

Some notes / *... * /...?

* / / * * notes several rows, and write the Javadoc document?

Usually, the lines of this annotation are as follows:?

/ * *?

*...?

*...?

*?

The Javadoc -d document stores the directory -author -version, the source file name.Java?

This command to compile a "source file name.Java" java source file, and generate documents stored in the document storage directory to the specified directory, index.html generated document is the document page. The two options for -author and -version can be omitted. ?

Two. Document annotation format?

1. formatting of documents and document annotations

The generated document is in HTML format, and the identifiers in these HTML formats are not Javadoc - added, but rather written when we write comments. ?

For example, to break, not in a carriage return, but if you want to write to
, it should be written in the

segment, segment. ?

The text of the document annotation is not copied directly to the output file (the document's HTML file), but after each line is read, the preceding header number and the previous space of the * number are deleted, and then entered into the document. Such as?

/ * *?

* This, is, first, line.,
?

A This is second line.
?

This, is, third, line.?

*?

2., the three part of the document annotation

Let's give you the following example

/ * *?

* a brief introduction to the show method

* detailed description of the

show method, line 1,
?

* detailed description of the second line of the show method?

* @param, B, true indicates the display, and false stands for hiding

* @return does not have a return value

*?

Public, void, show (Boolean, b) {?

Frame.show (b)?

}?

The first part is a brief introduction. In the document, for attributes and methods, there is a list first, and then a detailed description of the latter one

The part written in the front section of the document notes, the first period (.) before (i