如何使用javadoc注释中的标记

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

javadoc标记有如下一些:

@auther标记开发该类模块的作者

@version:标明该类模块的版本

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

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

@return: 对方法返回值的说明

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

@author:作者名

@version: 版本号

其中,@author可以多次使用,以指明多个作者之间使用<,>隔开.

@version也可以多次使用,只有一次有效使用@param,@return,@exception说明方法

这三个标记都只用于方法,@param描述方法的参数,@return描述方法的返回值,@exception描述可能抛出的异常值

@param参数名 参数说明

@return 返回值说明

@exception 异常类名 说明