Skip to content

Commit 81eaaaa

Browse files
Commit Appendix: Javadoc - Syntax
1 parent e7d1191 commit 81eaaaa

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

docs/book/Appendix-Javadoc.md

+36
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,42 @@ Javadoc输出为一个html文件,您可以使用web浏览器查看它。对于
1313

1414
以下是对Javadoc基础知识的介绍和概述。在 JDK 文档中可以找到完整的描述。
1515

16+
## 句法规则
17+
18+
所有Javadoc指令都发生在以 **/**** 开头(但仍然以 ***/** 结尾)的注释中。
19+
20+
使用Javadoc有两种主要方法:
21+
22+
嵌入HTML或使用“doc标签”。独立的doc标签是指令它以 **@** 开头,放在注释行的开头。(然而,前面的 ***** 将被忽略。)可能会出现内联doc标签
23+
24+
Javadoc注释中的任何位置,也可以,以一个 **@** 开头,但是被花括号包围。
25+
26+
有三种类型的注释文档,它们对应于注释前面的元素:类、字段或方法。也就是说,类注释出现在类定义之前,字段注释出现在字段定义之前,方法注释出现在方法定义之前。举个简单的例子:
27+
28+
```java
29+
30+
// javadoc/Documentation1.java
31+
/** 一个类注释 */
32+
public class Documentation1 {
33+
/** 一个属性注释 */
34+
public int i;
35+
/** 一个方法注释 */
36+
public void f() {}
37+
}
38+
39+
```
40+
41+
Javadoc处理注释文档仅适用于 **公共****受保护** 的成员。
42+
43+
默认情况下,将忽略对 **私有成员** 和包访问成员的注释(请参阅["隐藏实现"](/docs/book/07-Implementation-Hiding.md)一章),并且您将看不到任何输出。
44+
45+
这是有道理的,因为仅客户端程序员的观点是,在文件外部可以使用 **公共成员****受保护成员** 。 您可以使用 **-private** 标志和包含 **私人** 成员。
46+
47+
要通过Javadoc处理前面的代码,命令是:
48+
49+
**javadoc Documentation1.java**
50+
51+
这将产生一组HTML文件。 如果您在浏览器中打开index.html,您将看到结果与所有其他Java文档具有相同的标准格式,因此用户对这种格式很熟悉,并可以轻松地浏览您的类。
1652

1753
<!-- 分页 -->
1854

0 commit comments

Comments
 (0)