1 / 24
文档名称:

java 编码规范.xls

格式:xls   大小:85KB   页数:24页
下载后只包含 1 个 XLS 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

java 编码规范.xls

上传人:tggwft 2017/2/13 文件大小:85 KB

下载得到文件列表

java 编码规范.xls

相关文档

文档介绍

文档介绍:序号类别内容说明格式规范花括号左花括号前有空格,不折行;右花括号前无空格,折行; {}中的语句应该单独作为一行提高可读性在右花括号后面添加标识注释。提高可读性括号左括号和后一个字符之间不应该出现空格,同样,右括号和前一个字符之间也不应该出现空格。。提高可读性缩进缩进要求采用 4个空格,禁止使用制表符( TAB ) 提高可读性方法声明折行时,要求有缩进提高可读性方法调用语句有折行时,要求有缩进提高可读性赋值语句有折行时,要求有缩进提高可读性折行在逗号之后折行;提高可读性在运算符之前折行;提高可读性折行后对齐上一行语句同一层的起始位置;提高可读性空行包声明之后需要添加空行提高可读性导入声明之后需要添加空行提高可读性类、接口之间需要添加空行提高可读性方法之间需要添加空行提高可读性逻辑代码段之间需要添加空行提高可读性变量声明和语句之间需要添加空行提高可读性空格条件圆括号之前;提高可读性格式规范逗号、分号、类型转义圆括号之后;提高可读性运算符号的前后,运算符号包括(赋值、逻辑、关系、比较、数学、位移) 提高可读性长度限制检查一个文件的行数不超过 2000 。提高可读性每行代码不超过 120 个字符;提高代码可读性。方法行数不超过 300. 提高代码可读性。命名规范通用规范命名要有意义,以增加代码可读性提高可读性命名采用对应的英文单词或不易导致混淆的缩写提高可读性在命名长度不超过 29的情况下,不要使用单词缩写。命名采用对应的英文单词或不易导致混淆的缩写如果是单词的组合,使用“驼峰式”命名法 Java 的一般规则。包命名包的名称全部采用小写字母 Java 的一般规则。. 。包名规则为“”。类命名首字母大写,当 Class 名由多个单词组成时,每个单词的第 1个字母(段落)都要大写。 Java 的一般规则。类名唯一性。在工程所包含的的包中,每个名字都仅对应一个类。例外 Class 名的最后要加上“ Exception ”将提高代码的易读性。 Interface 名要基于 Class 名,如果需要与 Class 名区分,请在开头加上“I”将提高代码的易读性。抽象类要基于 Class 名,名字要以“ Abstract ”开始,再加上能联想到 Subclass 名的名字。将提高代码的易读性。命名规范接口实现类要基于 Class 名,并在最后加上“ Impl ”将提高代码的易读性。 Test Class 名的格式为“测试对象 Class 名+ Test ”将提高代码的易读性。方法命名方法的命名应采用含义对应的动词或词组;将提高代码的易读性。首字母小写;除第一个字母外,方法名中的每个单词片断的第一个字母采用大写格式。将提高代码的易读性。创建对象的 Method 名的格式是“"create"+Object 名”将提高代码的易读性。转换 Method 名的格式是“"to"+Object 名”将提高代码的易读性。属性相对应的 get 、 set 方法为 set(get)+ 属性名,属性名第一个字母为大写。将提高代码的易读性。返回 boolean 变量的 Method 名,建议使用“ is”+名词,或“ has ”+名称,或“ can “+名词。将提高代码的易读性。成员变量命名,首字母要小写; Java 的一般规则。常量命名常量全部用 static final 声明; Java 的一般规则。每个字母均采用大写格式,单词片断之间采用下划线“_”连接,相同类别的常量应使用同一前缀。 Java 的一般规则。注释规范版权注释版权信息必须在 java 文件的开头,包含项目名称、部门及版权信息,比如: 提高代码可读性,并可以生成规范 javadoc 文档。类注释类注释通常放在类定义的前面(类实体以外) 。通常详细介绍该类的功能,作者,版本,产生该类的时间和引用其他类等信息。提高代码可读性,并可以生成规范 javadoc 文档。方法注释方法注释的注释内容至少要包括描述***@param 和***@return 和***@exception 提高代码可读性,并可以生成规范 javadoc 文档。修改履历方法注释中包括修改履历记录提高代码可读性,并可以生成规范 javadoc 文档。代码注释若要修改单行代码,请在上一行使用单行注释,写明修改原因,人员姓名和日期。并且用单行注释符号注释原行代码提高代码可读性。注释规范对于冗余的程序代码,标注为冗余的代码行。并且在该代码的前一行注明注释原因,注释人员姓名和注释日期。提高代码可读性。非通用变量需要注释变量功能;提高代码可读性。复杂的分支流程要有分支功能说明注释;提高代码可读性。编写规范变量每行只声明了一个变量; 方便调试,提高可读