【www.bbyears.com--js教程】
@author name
描述作者 Class, Interface
@version version
版本条目,每个类或接口最多有一个 Class, Interface
@since since-text
描述这个功能块从何时有的 Class, Interface, Field, Method
@see reference
提供链接到其他文档元素的链接 Class, Interface, Field, Method
@param name
描述一个参数 Method
@return description
描述返回值 Method
@exception classname description
@throws classname description
描述该方法可能抛出的异常 Method
@deprecated description
描述一个过期的方法 Method
{@inheritDoc}
从复写方法出拷贝来得描述 Overriding Method 1.4.0
{@link reference}
连到其他的引用 Class, Interface, Field, Method
{@value}
返回一个静态作用域的值
如果注释中包含中文,有时候用eclipse导出的时候会出现乱码,以至于到处错误。下面的方法可以解决:
给 javadoc.exe 加上编码参数就OK。
具体的:
在Eclipse里 export 选 JavaDoc,在向导的最后一页的Extra JavaDoc Options 里填上参数即可
比如项目采用的是UTF-8的编码就填:-encoding UTF-8 -charset UTF-8