本篇文章为你整理了Javadoc（文档注释）详解（java文档注释怎么注释）的详细内容，包含有javadoc文档注释会生成什么文件 java文档注释怎么注释 java中doc注释 在java中使用文档注释的格式 Javadoc（文档注释）详解，希望能帮助你了解 Javadoc（文档注释）详解。

　　Java 支持 3 种注释，分别是单行注释、多行注释和文档注释。文档注释以/**开头，并以*/结束，可以通过 Javadoc 生成 API 帮助文档，Java 帮助文档主要用来说明类、成员变量和方法的功能。
 

　　文档注释只放在类、接口、成员变量、方法之前，因为 Javadoc 只处理这些地方的文档注释，而忽略其它地方的文档注释。
 

　　Javadoc 是 Sun 公司提供的一种工具，它可以从程序源代码中抽取类、方法、成员等注释，然后形成一个和源代码配套的 API 帮助文档。也就是说，只要在编写程序时以一套特定的标签注释，在程序编写完成后，通过 Javadoc 就形成了程序的 API 帮助文档。
 

　　API 帮助文档相当于产品说明书，而说明书只需要介绍那些供用户使用的部分，所以 Javadoc 默认只提取 public、protected 修饰的部分。如果要提取 private 修饰的部分，需要使用 -private。

　　Javadoc标签

　　Javadoc 工具可以识别文档注释中的一些特殊标签，这些标签一般以@开头，后跟一个指定的名字，有的也以{@开头，以}结束。Javadoc 可以识别的标签如下表所示：
 

　　
@tag 格式的标签（不被{ }包围的标签）为块标签，只能在主要描述（类注释中对该类的详细说明为主要描述）后面的标签部分（如果块标签放在主要描述的前面，则生成 API 帮助文档时会检测不到主要描述）。

　　{@tag} 格式的标签（由{ }包围的标签）为内联标签，可以放在主要描述中的任何位置或块标签的注释中。

　　Javadoc 标签注意事项：

　　
Javadoc 标签区分大小写，代码中对于大小写错误的标签不会发生编译错误，但是在生成 API 帮助文档时会检测不到该注释内容。

　　
在 cmd（命令提示符）中输入javadoc -help就可以看到 Javadoc 的用法和选项（前提是安装配置了JDK），下面列举 Javadoc 命令的常用选项：
 

　　
}

　　将文件命名为 Test.java，打开 cmd 窗口，输入 javadoc -author -version Test.java命令。如图 1 所示。
 

　　图 1 cmd 运行窗口

　　打开 Test.java 文件存储的位置，会发现多出了一个 Test.html 文档。打开文档，文档页面如图 2 和图 3 所示。
 

　　图 2 Student.html 页面（1）
 

　　图 3Student.html 页面（2）

　　注意：以上没有考虑编码格式的问题，注释中有汉字可能会乱码。使用javadoc -encoding UTF-8 -charset UTF-8 Test.java会解决编码问题。
 

　　MyEclipse生成API帮助文档

　　1）在 MyEclipse 中新建一个 Test 类，代码如下：

　　package test;

　　* @author C语言中文网

　　* @version jdk1.8.0

　　public class Test {

　　 public static void main(String[] args) {

　　 * 这是一个输出语句

　　 System.out.println( C语言中文网Java教程访问地址：http://c.biancheng.net/java/

　　}

　　注意：代码 9~11 行没有放在类、成员变量或方法之前，所以 Javadoc 会忽略这个注释。
 

　　2）在项目名处单击鼠标右键，然后选择Export...，如图 4 所示。

　　3）在弹出窗口中选择 Java 文件夹，点击 Java 文件夹下面的 Javadoc，然后点击 Next ，如图 5 所示。
 

　　图 5

　　4）选择你要生成 Javadoc 的项目，并更改你想保存的 API 帮助文档地址（默认为工程目录下，建议不要修改）。点击 Finish ，如图 6 所示。
 

　　图 6

　　5）点击 Finish 之后会问是否更新 Javadoc 文件的位置，只需要点击 Yes To All 即可，如图 7 所示。
 

　　图 7

　　6）这时可以看到控制台输出生成 Javadoc 的信息，如图 8 所示。
 

　　图 8

　　7）打开保存的文件夹，找到 Test.html 文件并打开，如图 9 所示。
 

　　图 9

　　以上就是使用 MyEclipse 简单建立一个 API 帮助文档的过程。

　　文档注释的格式

　　在编写文档注释的过程中，有时需要添加 HTML 标签，比如：需要换行时，应该使用 br ，而不是一个回车符；需要分段时，应该使用 p 。
 

　　例如把上面 Test 类改为以下代码：

　　package test;

　　* @author C语言中文网 br

　　* 严长生

　　* @version 1.8.0 br

　　* 1.9.0

　　public class Test {

　　 public static void main(String[] args) {

　　 System.out.println( C语言中文网Java教程访问地址：http://c.biancheng.net/java/

　　}

　　帮助文档格式如图 10 所示。
 

　　图 10
 

　　Javadoc 并不是将代码中的文档注释直接复制到帮助文档的 HTML 文件中，而是读取每一行后，删除前面的*号及*以前的空格再输入到 HTML 文档。
 

　　/**
 

　　* first line.
 

　　******* second line.
 

　　* third line.
 

　　*/

　　编译输出后的 HTML 源码如下所示。

　　first line. br
 

　　second line. br
 

　　third line.

　　注释前面的*号允许连续使用多个，其效果和使用一个*号一样，但多个*前不能有其他字符分隔，否则分隔符及后面的*号都将作为文档的内容。

　　关注公众号「站长严长生」，在手机上阅读所有教程，随时随地都能学习。本公众号由C语言中文网站长亲自运营，长期更新，坚持原创。

　　微信扫码关注公众号

　　Java字符串的替换（replace()、replaceFirst()和replaceAll()）

　　Linux libmcrypt及安装过程（LAMP环境搭建）

　　gethostbyname()函数：通过域名获取IP地址

　　归并排序算法（包含C语言实现代码）

　　UE4添加人物动画之状态机

　　Python range()快速初始化数字列表

　　PHP array_slice()：截取数组的一部分

　　JSON和JS对象的相互转换

　　C#基本语法

　　C#常量

　　以上就是Javadoc（文档注释）详解（java文档注释怎么注释）的详细内容，想要了解更多 Javadoc（文档注释）详解的内容，请持续关注盛行IT软件开发工作室。

郑重声明：本文由网友发布，不代表盛行IT的观点，版权归原作者所有，仅为传播更多信息之目的，如有侵权请联系，我们将第一时间修改或删除，多谢。