java中注释有三种:
- 单行注释 //注释的内容,
- 多行注释 /…注释的内容…/,
- 文档注释 /**…注释的内容….*/。
就是为了便于javadoc程序自动生成文档
这些都称之为java doc标记,含义如下:
@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向,也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明
其中,@author 可以多次使用,以指明多个作者,生成的文档中每个作者之间使用逗号 (,) 隔开。@version 也可以使用多次,只有第一次有效。@param、@return 和 @exception 这三个标记都是只用于方法的。