java如何实现文本规范性_JAVA代码注释规范

JAVA代码注释规范

一、规范存在的意义

1.好的注释规范可以让人一眼看明白这是干什么的，特别是对于我

们这种行业；共同合作完成一个项目需要分工明确，所以也需要

有明了的注释规范。

2.正确的应用注释规范可以增加代码的可读性、理解性。

3.好的代码规范可以提高团队的开发效率，从而节省时间。

4.长期的坚持代码规范可以让程序员养成一个良好的习惯，甚至锻

炼出思维。

二、命名规范

1.一般概念

1)尽量使用完整的英文描述。

2)采用相对好理解的术语。

3)采用骆驼命名的规范使名字增加可读性。

4)尽量少用缩写提高可读性。

5)避免名字过长。

6)避免使用类似的名字。

7)避免使用特殊符号。

2.主要的运用

1)类(class)的命名

2)接口(interface)的命名

+方法(method)的命名

3)参数(param)的命名

三、注释规范

1.一般概念

1)注释应该增加代码的清晰度

2)保持代码的整洁

3)在写代码之前或同时注意写上注释

4)注释出为什么做这件事，做这件事的结果

2.注释那些部分

1)java文件：版权信息、创建时间、创建人

2)类：目的、所完成功能、版权信息、创建人

3)方法：参数含义、返回值

4)属性：字段描述

5)接口：目的、创建人、版本号、创建时间

四、代码格式规范

1.单行注释://注释内容，一般与代码后空4-8格，注释必须对齐

2.块状注释：/*注释内容*/，一般是注释从以/*开始，以*/结束中

的所有内容。

3.文档注释：/**......*/所以注释文档必须书写在类、域、构造函数、

方法，以及字段(field)定义之前. 注释文档由两部分组成——描述、块标记。