@@ -26,7 +26,6 @@ Javadoc注释中的任何位置,也可以,以一个 **@** 开头,但是被
2626有三种类型的注释文档,它们对应于注释前面的元素:类、字段或方法。也就是说,类注释出现在类定义之前,字段注释出现在字段定义之前,方法注释出现在方法定义之前。举个简单的例子:
2727
2828``` java
29-
3029// javadoc/Documentation1.java
3130/* * 一个类注释 */
3231public class Documentation1 {
@@ -46,10 +45,164 @@ Javadoc处理注释文档仅适用于 **公共** 和 **受保护** 的成员。
4645
4746要通过Javadoc处理前面的代码,命令是:
4847
49- ** javadoc Documentation1.java**
48+ ``` cmd
49+ javadoc Documentation1.java
50+ ```
51+
52+ 这将产生一组HTML文件。 如果您在浏览器中打开index.html,您将看到结果与所有其他Java文档具有相同的标准格式,因此用户对这种格式很熟悉,并可以轻松地浏览你的类。
53+
54+ ## 内嵌 HTML
55+
56+ Javadoc传递未修改的HTML代码,用以生成的HTML文档。这使你可以充分利用HTML。但是,这样做的主要目的是让你格式化代码,例如:
57+
58+ ``` java
59+ // javadoc/Documentation2.java
60+ /* * <pre>
61+ * System.out.println(new Date());
62+ * </pre>
63+ */
64+ public class Documentation2 {}
65+ ```
66+
67+ 您你也可以像在其他任何Web文档中一样使用HTML来格式化说明中的文字:
68+
69+ ``` java
70+ // javadoc/Documentation3.java
71+ /* * You can <em>even</em> insert a list:
72+ * <ol>
73+ * <li> Item one
74+ * <li> Item two
75+ * <li> Item three
76+ * </ol>
77+ */
78+ public class Documentation3 {}
79+ ```
80+
81+ 请注意,在文档注释中,Javadoc删除了行首的星号以及前导空格。 Javadoc重新格式化了所有内容,使其符合标准文档的外观。不要将诸如 \< h1\> 或 \< hr\> 之类的标题用作嵌入式HTML,因为Javadoc会插入自己的标题,后插入的标题将对其生成的文档产生干扰。
82+
83+ 所有类型的注释文档(类,字段和方法)都可以支持嵌入式HTML。
84+
85+ ## 示例标签
86+
87+ 以下是一些可用于代码文档的Javadoc标记。在尝试使用Javadoc进行任何认真的操作之前,请查阅JDK文档中的Javadoc参考,以了解使用Javadoc的所有不同方法。
88+
89+ ### @see
90+
91+ 这个标签可以将其他的类连接到文档中,Javadoc 将使用 @see 标记超链接到其他文档中,形式为:
92+
93+ ``` java
94+ @see classname
95+ @see fully- qualified- classname
96+ @see fully- qualified- classname#method- name
97+ ```
98+
99+ 每个都向生成的文档中添加超链接的“另请参阅”条目。 Javadoc 不会检查超链接的有效性。
100+
101+ ### {@link package.class#member label}
102+
103+ 和 @see 非常相似,不同之处在于它可以内联使用,并使用标签作为超链接文本,而不是“另请参阅”。
104+
105+ ### {@docRoot }
106+
107+ 生成文档根目录的相对路径。对于显式超链接到文档树中的页面很有用。
108+
109+ ### {@inheritDoc }
110+
111+ 将文档从此类的最近基类继承到当前文档注释中。
112+
113+ ### @version
114+
115+ 其形式为:
116+
117+ ``` java
118+ @version version- information
119+ ```
120+
121+ 其中 version-information 是你认为适合包含的任何重要信息。当在Javadoc命令行上放置 -version 标志时,特别在生成的HTML文档中用于生成version信息。
122+
123+ ### @author
124+
125+ 其形式为:
126+
127+ ```
128+ @author author-information
129+ ```
130+
131+ author-information 大概率是你的名字,但是一样可以包含你的 email 地址或者其他合适的信息。当在 Javadoc 命令行上放置 -author 标志的时候,在生成的HTML文档中特别注明了作者信息。
132+
133+ 你可以对作者列表使用多个作者标签,但是必须连续放置它们。所有作者信息都集中在生成的HTML中的单个段落中。
134+
135+ ### @since
136+
137+ 此标记指示此代码的版本开始使用特定功能。例如,它出现在HTML Java文档中,以指示功能首次出现的JDK版本。
138+
139+ ### @param
140+
141+ 这将生成有关方法参数的文档:
142+
143+ ``` java
144+ @param parameter- name description
145+ ```
146+
147+ 其中parameter-name是方法参数列表中的标识符,description 是可以在后续行中继续的文本。当遇到新的文档标签时,说明被视为完成。@param 标签的可以任意使用,大概每个参数一个。
148+
149+ ### @return
150+
151+ 这记录了返回值:
152+
153+ ``` java
154+ @return description
155+ ```
156+
157+ 其中description给出了返回值的含义。它可延续到后面的行内。
158+
159+ ### @throws
160+
161+ 一个方法可以产生许多不同类型的异常,所有这些异常都需要描述。异常标记的形式为:
162+
163+ ``` java
164+ @throws fully- qualified- class- name description
165+ ```
166+
167+ fully-qualified-class-name 给出明确的异常分类名称,并且 description (可延续到后面的行内)告诉你为什么这特定类型的异常会在方法调用后出现。
168+
169+ ### @deprecated
170+
171+ 这表示已被改进的功能取代的功能。deprecated 标记表明你不再使用此特定功能,因为将来有可能将其删除。标记为@不赞成使用的方法会导致编译器在使用时发出警告。在Java 5中,@deprecated Javadoc 标记已被 @Deprecated 注解取代(在[ 注解] ( ) 一章中进行了描述)。
172+
173+ ## 文档示例
174+
175+ ** objects/HelloDate.java** 是带有文档注释的例子。
176+
177+ ``` java
178+ // javadoc/HelloDateDoc.java
179+ import java.util.* ;
180+ /* * The first On Java 8 example program.
181+ * Displays a String and today's date.
182+ * @author Bruce Eckel
183+ * @author www.MindviewInc.com
184+ * @version 5.0
185+ */
186+ public class HelloDateDoc {
187+ /* * Entry point to class & application.
188+ * @param args array of String arguments
189+ * @throws exceptions No exceptions thrown
190+ */
191+ public static void main (String [] args ) {
192+ System . out. println(" Hello, it's: " );
193+ System . out. println(new Date ());
194+ }
195+ }
196+ /* Output:
197+ Hello, it's:
198+ Tue May 09 06:07:27 MDT 2017
199+ */
200+ ```
201+
202+ 你可以在Java标准库的源代码中找到许多Javadoc注释文档的示例。
203+
50204
51- 这将产生一组HTML文件。 如果您在浏览器中打开index.html,您将看到结果与所有其他Java文档具有相同的标准格式,因此用户对这种格式很熟悉,并可以轻松地浏览您的类。
52205
53206<!-- 分页 -->
54207
55- <div style =" page-break-after : always ;" ></div >
208+ <div style =" page-break-after : always ;" ></div >
0 commit comments