(好的代码已经是一份好的文档,所以写注释是一门学问!)
javadoc的注释
javadoc的注释方式已经忘得差不多,需要复习一下。
/** ...... */ 注释若干行,并写入 javadoc 文档,命令行为:javadoc -d 文档存放目录 -author -version 源文件名.java,在Eclipse中Porject-> Generate Javadoc...
在/** */里面是可以使用HTML的脚本,例如<li>,<br>等等。可以在类,方法之前加入注释说明。例子如下:
/**
* 方法/类的简述.
* <p>详细说明第一行<br>
* 详细说明第二行
* @param ,用于参数描述
* @return ,描述返回之没有返回值
*/@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向,也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明
@author 作者名
@version 版本号