》》Java中有两种注释风格:
(1)、多行注释:
/*
*
*/
(2)、单行注释:
//
----------注释文档
》》javadoc 是用于提取注释的工具,它是 JDK 安装的一部分。它采用了
java 编译器的某些技术,查找程序内的特殊注释标签。它不仅解析由
这些标签标记的信息,也将毗邻注释的类名或方法名抽取出来。如此,
我们就可以用最少的工作量,生成相当好的程序文档。
》》javadoc 输出的是一个 HTML 文件,可以用 Web 浏览器查看。这样,
该工具就使得我们只需要创建和维护单一的源文件,并能自动生成
有用的文档。有了 javadoc ,就有了创建文档的简明直观的标准。
----------语法
》》javadoc 命令:
/** */
》》共有三种类型的注释文档,分别对应于注释位置后面的三种元素:
类、域、方法。类注释正好位于类定义之前;域注释正好位于域
定义之前;方法注释正好位于方法定义之前。
》》注意:javadoc 只能为 public 和 protected 成员进行文档注释。private
和包内可访问成员的注释会被忽略掉,所以输出结果中看不到它
们 (不过可以用 -private 进行标记,以便把 private 成员的注释
也包括在内)
》》使用javadoc 的方式有两种:
一种是:嵌入HTML ,或使用“文档标签”。独立文档标签是一些以
“@” 字符开头的命令,且要置于注释行的最前面。
一种是:行内文档标签,则可以出现在 javadoc 注释中的任何地方,
它们也是以 “@”字符开头,但要括在花括号内。
----------嵌入式 HTML
----------一些标签示例
参考可用于代码文档的 javadoc 标签
---------文档示例