java代码注释规范

Posted SaraMorning

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了java代码注释规范相关的知识,希望对你有一定的参考价值。

1、单行(single-line)注释:“//……”

2、块(block)注释:“/*……*/”

3、文档注释:“/**……*/”

4、javadoc 注释标签语法

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

@version   对类的说明 标明该类模块的版本

@see     对类、属性、方法的说明 参考转向,也就是相关主题

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

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

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

以上是关于java代码注释规范的主要内容,如果未能解决你的问题,请参考以下文章

java 注释规范 参照

java代码注释规范

IT兄弟连 Java语法教程 注释与编码规范

JAVA注释规范

java注释代码规范

3.7 代码注释和编码规范