java 文档注释规范_java文档注释规范

javadoc 标记由"@"及其后所跟的标记类型和专用注释引用组成

javadoc 标记有如下一些：

@ author 标明开发该类模块的作者

@ version 标明该类模块的版本

@ see 参考转向，也就是相关主题

@ param 对方法中某参数的说明

@ return 对方法返回值的说明

@ exception 对方法可能抛出的异常进行说明

-------------------------------------------------------------------------------------------------------------

@ author 作者名

@ version 版本号

其中，@ author 可以多次使用，以指明多个作者，生成的文档中每个作者之间使用逗号 (,) 隔开。@ version 也可以使用多次，只有第一次有效

-------------------------------------------------------------------------------------------------------------

使用 @param、@ return 和 @ exception 说明方法

这三个标记都是只用于方法的。

@ param 描述方法的参数，

@ return 描述方法的返回值，

@ exception 描述方法可能抛出的异常。

它们的句法如下：

@ param 参数名参数说明

@ return 返回值说明

@ exception 异常类名说明