java 注释及javac的注释标签写法规范

写这个日志的目的是为了规范化代码，因为我在项目维护中，发现之前同事留下的代码没有注释，而且不规范，看起来着实蛋疼，好像都是开始骂一遍，然后撸吧。

 

// 注释一行 
/* ...... */ 注释若干行 
/** ...... */ 注释若干行，并写入 javadoc 文档 

翻译后是没有注释的，可以用JD-GUI反编译，是没有注释的。

 

生成的文档是 HTML 格式，所以按照html语法写，

回车：<br>

分段： <p>

javadoc 标记有如下一些： 
@author 标明开发该类模块的作者 
@version 标明该类模块的版本 
@see 参考转向，也就是相关主题 
@param 对方法中某参数的说明 
@return 对方法返回值的说明 
@exception 对方法可能抛出的异常进行说明 

 

还有一些，可以参见java的源码书写方式。