黑马程序员技术交流社区

标题: java代码规范总结 [打印本页]

---

作者: 高欢欢    时间: 2012-7-17 22:05
标题: java代码规范总结
作为一名合格的程序员，代码就是其战斗的武器，因此，武器的好坏，武器的品质，也一定程度上体现了程序员的水平和影响对功能的实现，因此良好的代码的规范，在一定程度上，所表现的作用是很大的，应该引起广大程序员，尤其是初级程序员的注意。因此，我总结了一下几点：
1.命名规范
1).所有的标示符只能用英文字母，数字，下划线
2).包名全小写
3).类名是一个名词，大小写混合，每个单词的首字母大写
4).接口的规则与类名相似
5).方法名第一个字母小写，中间单词的首字母大写，采用驼峰标识
6).变量名的规则与方法名相似
7).常量的声明是全部大写，每个单词之间用"_"连接

2.注释规范
注释有：单行注释 "//", 多行注释 "/*..*/", 文档注释 "/**....*/"
1).注释尽可能使用“//”,对于所有的javadoc的注释则使用“ /**....*/ ",而临时对代码快进行注释尽量使用”/*...*/“。
2).所有的源文件都应该在开头有一个注释，其中列出文件名，日期和类的功能概述，有时还有作者
3).每个方法必须添加文档注释(类的main()方法除外)，这样可以使其他人了解这个方法的功能
4).每个属性必须添加注释，让人知道这个属性的含义
5).代码中至少包含15%的注释
6).注释中英文都可

3.缩进排版规范
1).代码应避免一行长度超过60个字符
2).4个空格常被作为缩进排版的一个单位。缩进的确切解释并未详细指定(空格 vs. 制表符)。一个制表符等于8个空格(而非4个)。
3). 换行(Wrapping Lines)当一个表达式无法容纳在一行内时，可以依据如下一般规则断开之：
a. 在一个逗号后面断开
b. 在一个操作符前面断开
c. 宁可选择较高级别(higher-level)的断开，而非较低级别(lower-level)的断开
d. 新的一行应该与上一行同一级别表达式的开头处对齐 e. 如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边，那就代之以缩进8个空格
4).关键词和操作符之间加适当的空格
5).相对独立的程序块与块之间加空行
6).划分出的新行要进行适应的缩进，使排版整齐，语句可读.
7).循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分。 .函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格

4.文件名规范
1).一个java源文件只能存储一个java类
2).文件名与java类名相同
3).一个类文件的代码行不超过200行
5.声明规范
1).一行声明一个变量
2).不要将不同类型变量的声明放在同一行
3).只在代码块的开始处声明变量
4).所以的变量必须在声明时初始化
5).避免声明的局部变量覆盖上一级声明的变量
6).方法与方法之间以空行分隔

6.语句规范
1).每行至少包含一条简单语句。
2).在return语句中，返回值不使用小括号“()”括起来。
3).if语句总是用“{”和“}”括起来。
4).在for语句的初始化或更新子句中，避免因使用三个以上变量，而导致复杂度提高。
5).当switch的一个case顺着往下执行时(因为没有break语句)，通常应在break语句的位置添加注释。

7.编程规范
1).提供对实例以及类变量的public或private访问控制，尽可能不使用默认值或protected访问控制。
2).避免用一个对象访问一个类的静态变量或方法。应该用类名代替。
3).避免在一个语句中给多个变量赋相同的值。
4).用switch()语句实现多路分支。
5).如果使用JDBC，则考虑使用java.sql.PreparedStatement，而不是java.sql.Statement。
6).用于设置对象状态的方法前缀必须是set；用于检索一个布尔类型对象状态的方法前缀必须是is，而用于检索其他方法前缀必须是get。
7).程序中应尽可能少使用数字（或字符），尽可能定义静态变量来说明该数字（或字符）的含义。程序中需要赋值或比较时，使用前面定义的静态变量。在循环控制中例外。

---

欢迎光临 黑马程序员技术交流社区 (http://bbs.itheima.com/)

黑马程序员IT技术论坛 X3.2