java 关于文档注释

关于文档注释

java中的文档注释，除了可以在日常开发中方便查看具体功能外，也可以通过工具抽取，生成具体文档，集中整理。

标签列表

标签	描述
@author	作者
@deprecated	指明一个过期的类或成员
{@docRoot}	指明当前文档根目录的路径
@exception	标志一个类抛出的异常
{@inheritDoc}	从直接父类继承的注释
{@link}	插入一个到另一个主题的链接
{@linkplain}	插入一个到另一个主题的链接，但是该链接显示纯文本字体
@param	说明一个方法的参数
@return	说明返回值类型
@see	指定一个到另一个主体的链接
@serial	说明一个序列化属性
@serialData	说明通过 writeObject() 和 writeExternal() 方法写的数据
@srialField	说明一个 ObjectStreamField 组件
@since	标记当引入一个特定的变化时
@throws	和@exception标签一样
{@value}	显示常量的值，该常量必须是static属性
@version	指定类的版本

文档注释示例

/**
* @author 		zm
* @param 		UserInfo
* @return 		type
* @exception 	IOException
* @version 		1.2
*/

javadoc

javadoc 工具将你 java程序的源代码作为输入，输出一些包含你程序注释的HTML文件。

每一个类的信息将在独立的HTML文件里，javadoc也可以输出继承的树形结构和索引。

关于自定义注释

很多注释都是可以自定义的，定义模板在自己的 IDE 上，这样每次通过快捷键就可以自动帮你输出在方法中。可以加载 JAutodoc 插件到 IDE 中。