摘自Think in java

    前面看到一位同事写的android程序，注释如同android源码一样，再看看自己写的，自己都都不懂的注释。所以抽空看了Think in java里面注释和嵌入式文档的章节，并做一个简单的总结备忘。

Java中的注释分为两种，// /* */

嵌入式文档使用了一种特殊的注释语法，通过javadoc工具(javadoc工具为jdk安装的一部分)生成HTML文档，可以使用web浏览器来查看。

语法：

所有的javadoc命令都只在/** 后的注释中才会生效。

嵌入式文档主要有两种 嵌入式HTML和文档标签，其中文档标签又分为独立文档标签（一些以@字符开头的命令，且要置于注释行的最前面）和行内文档标签（可以出现在任何地方，但是需要用花括号括起来）。

类型：

嵌入式文档有三种类型，分别放在类，域和方法前面。其中javadoc只会为public和protected的成员生成文档注释。

 

标签举例：

@see 引用其他类的文档

@see classname#method-name

See Also为超链接

 

{@link package.class#method label}该标签和@see很相似，只是它用在行内。label为超链接文本

 

其它常见的还有

@version

@version version-information

@author

@author author-information

 

@param parameter-name description

@return description

@throws class-name description

@deprecated