java中javadoc的使用。

此处以在myeclipse中使用javadoc为例，来简要介绍javadoc的使用。

所有的javadoc命令都只能在/**注释中出现，并以*/为结尾。使用javadoc有两种方式，一种为“HTML”即在其中可以迁入HTML，可以使用各种HTML标签。另一种为文档标签，其是以“@”字符开头的一些命令。javadoc只能为public和protected的成员进行注释，private成员的注释会被忽略掉。

如上图例所示，对类中的的一个int 型变量i添加javadoc注释，在其他用到i的地方，鼠标指针经过即可显示相应的注释信息。不使用myeclipse等集成开发环境则需调用javadoc命令来查看。

我们也可以添加HTML标签，如下图，我们添加了HTML列表。及一些简单的@标签：

我们使用了HTML的<ol>有序列表标签。可以在javadoc中按所要求的顺序显示。而@author表示作者信息，利用javadoc -author命令可以提取作者信息。

其他一些相关的@文档标签如下所示：

1、@see：引用其他类，或者类的方法。产生链接到相应类的超链接，点击可以查看相关类的javadoc

@see classname

@see classname#method-name

2、{@link package.class#member label}

与@see标签类似，只是用于行内以label作为超链接文本。

3、{@docRoot}

产生到文档根目录的相对路径。

4、{@inheritDoc}

从这个类最直接的基类中继承注释到此类的文档注释中。

5、@version

用于表明开发产品的版本信息。

6、@since

制定程序代码早期使用的版本。

7、@param

@param parameter-name description

用于描述方法的各个参数。

8、@return

@return description 描述返回值的含义。

9、@throws 

@throws class description

描述一个异常类的相关信息。

10、@deprecated

表示一些旧特性已经被新特性取代了，建议用户不要再使用这些旧特性。使用的话会出现编译警告。