javadoc的注释一定要以/**开头,*/结尾,如
tags:
用法:
@see classname
@see fully-qualified-classname
@see fully-qualified-classname#method-name
另外几个插入型的标签:(资料引用:http://www.knowsky.com/363815.html)
功能:创建超链接,链接到其他类或方法(如果再同一个HTML下则生成超链接,如果没有就不能生成)
出现在文档的seealso(另请参阅)块中
@version
用法:
@version version-information
功能:标注版本
出现在文档的version(版本)块中
@author
用法:
@author author-information
功能:标注作者
出现在文档的author(作者)块中
@since
用法:
@since information
功能:标注从什么版本,什么时候开始被使用
出现在文档的(从以下版本开始)块中
@param
用法:
@param parameter-name description
功能:标注每个方法的各个参数的用途
出现在方法详细资料块中
@return
用法:
@return description
功能:标注方法返回值的含义
出现在方法详细资料块中
@throws
用法:
@throws fully-qualified-class-name description
功能:标注方法抛出的异常
出现在方法详细资料块中
@deprecated
标注已经废除的淘汰的,不建议使用的功能
eclipse如何使用javadoc导出文档:
文件-->导出-->java--->javadoc--->下一步--> 完成
对于javadoc命令的配置,一般在/jdk/bin/javadoc.exe。我的是C:\Program Files\Java\jdk1.7.0_01\bin\javadoc.exe。仅供参考
对于以上标签的效果测试:
有两个类,test和Pig(注意test命名不规范)
结果:
{@link package.class#member label}:产生超链接
用法:
/** Use the {@link #getComponentAt(int, int) getComponentAt} method. */
{@docRoot}:产生文档的根路径
用法:
/**
*see the <a href={@docroot}/copyright.html>copyright</a>
*/
{@inheritDoc}:继承最近的父类的文档到本文档