Java编码规范模板.xlsVIP

Java注释规范Checklist

Java编码规范Checklist

Java编码规范Checklist

文件编码：

项目名称：

检查日期：

项目编号：

检查人：

项目负责人：

确认人：

检查大项

检查子项

完成情况

备注

规范性

编码是否符合了公司发布的JAVA编码规范

编码风格

代码是否以TAB4缩进

是否程序最大行宽不能不超过90列

是否单个函数长度不应大于100行（不包括注释行)

括号：

1、是否类、接口、方法、控制、条件、循环的左括号紧跟该代码段最后一句后，且不单独占行

2、右括号是否单独占一行

3、else或elseif语句是否紧跟上一个右括号

类、方法等之间是否以空行相隔

操作符前后是否以空格相隔

类命名：

1、是否是大小写混合形式，且所有单词首字母大写

2、是否命名能间接而确切地反应该类的含义

3、是否命名使用完整单词，并避免缩写词

接口是否使用I前缀，规则是否与类的命名规则相同

包名是否一律小写，多单词以下划线连接

字段是否采用完整的英文描述，是否第一个字母小写，是否任何中间单词的首字母大写

属性：

1、可读布尔属性命名被访问字段名的前面是否加前缀get

2、可读非布尔属性获取函数是否用单词is（has）做前缀

3、被访问字段名的前面是否加上前缀set

方法命名

1、是否采用完整的英文描述符，是否大小写混合使用，是否首字母小写，并且中间单词的第一个字母大写

2、是否第一个单词采用一个有强烈动作色彩的动词

3、方法参数顺序是否是：被操作者，操作内容，操作标志，其他

变量命名是否采用完整的英文描述符，名字中所有非开头的单词的第一个字母应大写，开头字母小写

数组和集合命名是否使用复数来他们代表多值

部件和组件命名是否使用完整的英文描述来说明组件的用途，将组件类型使用匈牙利命名法则作其前缀

异常是否采用字母e表示

常量是否采用完整的英文大写单词，是否在词与词之间用下划线连接

声明规范性

包声明：在导入包时应该完全限制代码所使用的类的名字，而避免使用通配符的方式

类、接口声明：

1、公共和保护接口是否是最小化，是否在编写代码前必须先定义接口

2、声明顺序是否是：私有字段、公有/受保护字段、构造函数、公共成员、被保护成员、私有成员

字段声明：

1、是否所有字段设置为私有

2、是否没有“隐藏”字段

是否一行代码只声明一个变量

是否没有不必要的公共成员方法

表达式与语句

每行是否至多包含一条语句

功能块间是否以空行相隔

判断中如有常量，常量是否置与判断式的左侧

是否没有使用三目条件判断

循环跳转条件是否注明清楚

本次检查小计：

合格√

合格项数量：

一般符合

一般符合项数量：

不符合

不符合项数量：

不适用

不适用项数量：

Java注释规范Checklist

注释是否符合了公司发布的JAVA注释规范

文档注释规范性

文档注释是否被置于注释定界符/**...*/之中

文件注释：

1、每个文件，在包的头部是否对该文件的作者、版权以及修改记录等进行注解

2、对于文件修改记录，在正式版本发布之后，对业务有较大影响或者较大修改的，是否添加修改记录

在类、接口定义之前是否对其进行注释，并包括类、接口的目的、作用、功能，实现的接口以及重大的修改记录

方法注释：

1、是否依据标准JavaDoc规范对方法进行注释

2、是否明确该方法功能、作用、各参数含义以及返回值等信息

程序中用到的常量、关键的类的属性字段等，是否进行注释明确其含义

实现注释规范性

单行语句注解是否比其注解的语句缩进两个字符、

注释符后是否紧跟一个空格，然后才是注释信息

不易理解的分支条件表达式是否添加注释

对文件，方法，数据结构和算法的描述是否使用块注释

代码未端注释如果与代码同行，是否保留足够的空白分割

行末注释是否以//界定，并且注释符//必须紧跟一个空格

复杂的算法是否使用/**/在方法内注解出