Java 注释和嵌入式文档

备注：希望看过后的朋友，对注释要特别注意，走规范之路

Java 注释和嵌入式文档

一、      Java 里面有两种注释风格：

1.    第一种:以/**开始，*/结束  多行注释

/**                        

*  hello     

*/

2.    第二种:  //  单行注释

Eg.// this is a example

二、    注释文档

1.    javadoc:提取注释的工具。工作原理：查找程序内的特殊注释标签，解析特殊标签标记的信息，也将毗邻注释的类名或者方法名抽取出来。

2.    javadoc:输出一个HTML文件。

3.    所有的注释文档-------类，域和方法-----都支持嵌入式HTML

  Eg： /**

         * <b> hello </b>

         */

三、    标签实例

1.    @see :引用其他类。

@see 标签允许用户引用其他类的文档。Javadoc 会在其他生成的HTML文件中，通过连接到其他文档。Eg:

@see classname

 @seefully-qualified-classname

@see fully-qualified-classname#method-name 相当于html中的锚

上述每种格式都会在生成的文档加入一个具有超链接的“See also（参见）”，javadoc 不会检查你所提供的超链接是否有效。

2.    {@linkpackage.class#member label}  该标签与@see 极其相似，只是它用于行内，并且是用”label” 作为超链接文本而不用“See also”。

3.    {@docRoot} 该标签产生到文档根目录的路径，用于文档树页面的显示超链接。

4.    {@inheritDoc}该标签从当前这个类的最直接的基类中继承相关文档到当期的文档注释中。

5.    @versionversion-information 生成的HTML 文档中提取出版本信息。

6.    @authorauthor-information

author-information :包括个人信息，电子邮件，其他任何合适的信息。生成的HTML文档中提取作者信息。

不能在 method文档中使用标记 @author。只能在以下类型的文档中使用该标记：overview, package,class/interface。

7.     @since 该标签允许指定程序代码的最早使用的版本

8.    @param该标签用于方法文档中，形式如下:

@param paramerter-name  description parameter-name是方法的参数列表中的标识符，description 是可延续数行的文本，终止于新的文档标签出现之前。

@param argument "String" 不是参数名称

9.    @return 格式如下：@return description ，其中”description” 用来描述返回值的定义，可以写数行。

      不能在返回类型为 void的方法中使用 @return 标记。

10.   @throws    异常标签的格式如下：

@throws  fully-qualified-class-name  description 

四、    导出帮助文档步骤

     Eclipseàexportà Javaà@javadoc