Commit Appendix: Javadoc - Syntax

This commit is contained in:
withthewind
2019-09-21 12:58:42 +08:00
parent e7d1191655
commit 81eaaaa0bc

View File

@@ -13,6 +13,42 @@ Javadoc输出为一个html文件您可以使用web浏览器查看它。对于
以下是对Javadoc基础知识的介绍和概述。在 JDK 文档中可以找到完整的描述。
## 句法规则
所有Javadoc指令都发生在以 **/**** 开头(但仍然以 ***/** 结尾)的注释中。
使用Javadoc有两种主要方法:
嵌入HTML或使用“doc标签”。独立的doc标签是指令它以 **@** 开头,放在注释行的开头。(然而,前面的 ***** 将被忽略。)可能会出现内联doc标签
Javadoc注释中的任何位置也可以以一个 **@** 开头,但是被花括号包围。
有三种类型的注释文档,它们对应于注释前面的元素:类、字段或方法。也就是说,类注释出现在类定义之前,字段注释出现在字段定义之前,方法注释出现在方法定义之前。举个简单的例子:
```java
// javadoc/Documentation1.java
/** 一个类注释 */
public class Documentation1 {
/** 一个属性注释 */
public int i;
/** 一个方法注释 */
public void f() {}
}
```
Javadoc处理注释文档仅适用于 **公共****受保护** 的成员。
默认情况下,将忽略对 **私有成员** 和包访问成员的注释(请参阅["隐藏实现"](/docs/book/07-Implementation-Hiding.md)一章),并且您将看不到任何输出。
这是有道理的,因为仅客户端程序员的观点是,在文件外部可以使用 **公共成员****受保护成员** 。 您可以使用 **-private** 标志和包含 **私人** 成员。
要通过Javadoc处理前面的代码命令是
**javadoc Documentation1.java**
这将产生一组HTML文件。 如果您在浏览器中打开index.html您将看到结果与所有其他Java文档具有相同的标准格式因此用户对这种格式很熟悉并可以轻松地浏览您的类。
<!-- 分页 -->