Javadoc编写文档注释

Javadoc生成注释文档：

javadoc:

作为提取注释的工具，也是JDK安装的一部分。可查找程序内特殊注释文档。生成HTML文件

语法介绍：

所有javadoc都只能在”/*”和”/”之间

使用javadoc的方式主要有两种：

1.嵌入HTML或者“文档标签”

2.独立文档标签是一些以”@”字符开头的命令，且要至于注释前的最面，

行内文档标签出现在javadoc注释的任何地方，也是以“@”开头，但要在{}内

共有三种类型的注释文档，分别对应于注释的三种元素：类，域，方法

类注释是位于类定义之前，域注释位于域定义之前，方法注释位于方法定义之前

在MyEclipse下进行javadoc配置：

window → preferences → Java → CodeStyle → Code Templates

javadoc只能对public和protected进行文档注释

【不过可以进行-private进行标记，以便把private成员注释包括在内，
· 只有public和protected可以在文件之外使用】

嵌入式HTML

javadoc通过生成的HTML文档进行html指令

如：

---

实现注释：//…

文档注释：/* /

关于文档和文档注释的格式化：

生成的文档是HTML格式，此HTML格式的标识符非Javadoc所加。而是我们

写注释的时候自己加的。

换行时，写入

分段，写入

格式化文档本质就是添加相应的HTML标识

文档注释只说明紧接其后的类，属性和方法

文档注释总体上的三部分：

/**
*show方法的简述
*

show 方法的详细说明第一行
*特殊说明，参数讲解
*/

使用javadoc标记

用于标识代码中的特殊引用。javadoc标记由“@”及其后所跟

的标记类型和专用注释引用所组成

三部分： @，标记类型，专用注释引用

@和标记类型之间有时可以用空格符分隔，但是推荐他们紧挨着写，

以较少出错