Java编码规范及实践
目录
Java编码规范及实践 (1)
1.2术语 (2)
1.3约束 (3)
||!(condition5 && condition6)) { (14)
4.1一般命名规范 (14)
IQuery, IDataAccess,IReportBuilder (15)
MAX_TIMES, DEFAULT_NAME (15)
4.2特殊命名规范 (17)
AbstractReportBuilder，AbstractBeanFactory (18)
AccessException, RuntimeException (19)
5.2一般原则 (20)
1.代码应该和注释保持同步，如果代码和注释不同步，则阅读代码的人会 (20)
2.注释尽量简洁，尺度没有准确的定义，大部分人能明白即可，可以将自 (20)
Result getResult() throws Exception{ (21)
Object getAction(); (22)
JavaDoc 工具不要改变格式. (22)
Get a default date/time formatter that uses the SHORT (23)
Thread.sleep(1000); (24)
Derived，如果一个方法可以接受基类对象b 的话：method1(Base b), (25)
7.1工厂模式 (26)
7.1.1简单工厂 (26)
7.1.2工厂方法 (26)
7.2单例模式 (27)
Client: (27)
7.3适配器模式 (28)
7.4组合模式 (29)
Client: (29)
7.5外观模式 (30)
Client: (30)
7.6代理模式 (31)
7.7命令模式 (32)
Client: (33)
7.8观察者模式 (33)
7.9策略模式 (35)
Client: (35)
IKeyPairGenerable desGenerator = (35)
IKeyPairGenerable rsaGenerator = (36)
IKeyPairGenerable ideaGenerator = (36)
KeyPairManager manager = new KeyPairManager(); (36)
7.10模版方法模式 (36)
7.11参观者模式 (38)
总价格 (40)
Client: (40)
第1章概述
1.1前言
代码之于程序员，就像零件之于机械工，庄稼之于农民，它是软件的基石，一行行代码都是程序员的心血经过日日夜夜凝结成的。做为一个程序员，应该像母亲呵护孩子一样呵护自己的代码，它不仅仅是一行一行的文字，它是一个程序员的尊严和价值所在；它是活的，你甚至能感受到它的心跳。编码规范只是大家达成一致的约定，这样大家的代码就可以互相看懂，维护起来更加容易，思想更畅快的交流，经验更快的得到传播。代码规范不是束缚程序员的桎梏，应该知道，不遵守规范的个性的代码并不代表程序员的性格，
并不能张扬个性。个性应该体现在用更简单、更优雅、更易读、更易理解以及算法实现效率更高等方面。
可读性，可理解性是代码的重要方面，本规范主要围绕如何去产生规范易读的代码。另外，它也保证了大家有共同的先验知识。
1.2术语
Pascal case－所有单词第一个字母大写，其它字母小写。
例：Person, OrderDetail, OilTank。
Camel case－除了第一个单词，所有单词第一个字母大写，其他字母小写。
例：oilLevel, customerName
在后面的描述中我们使用Pascal 代表第一种表示方式， Camel 代表第二种表示方式。
1.3约束
没有一个规范可以到处适用，也不可能无所不包。
1．2．本规范并非完全强制性规范，对于任何违背本规范但能提高代码可读性的措施，都可以采用。
本规范第3，4，5 章为强制性规范，其它章节为建议规范。如违背本条，请参考第一条。
第2章一般规则
1) 所有包，类，接口，方法，属性，变量，参数均使用英文单词进行命名，具
体细节请参见命名规范一章。
2) 命名包，类，接口，方法以及变量时，尽量使用贴近问题域的表意丰富的名
称。
3) 修改源代码时，应尽量保持与所修改系统的编码风格保持一致。
4) 所有包名使用必须使用com.[company] 前缀，所有项目使用com.
[company].[project name], company是公司简称，project name 是项目的缩写。
第3章格式规范
5) 包的导入应该按照相关性进行分组。
import java.io.IOException;
import https://www.doczj.com/doc/6711718849.html,.URL;
import java.rmi.RmiServer;
import java.rmi.server.Server;
import javax.swing.JPanel;
import javax.swing.event.ActionEvent;
import org.linux.apache.server.SoapServer;
6) 只倒入明确需要的类，这样只要看导入列表，就可以知道该类依赖于哪些类
和接口，保证可读性。
import java.util.List; //避免: import java.util.*
import java.util.Arraylist;
import java.util.HashSet;
7) 类和接口中元素的布局顺序。
1．类和接口的文档描述
2．类和接口的声明
3．类的静态变量，按照public，protected，private 的顺序。
4．实例变量，按照public，protected，private 的顺序。
5．类的方法，无固定顺序。
8) 类的声明，基类和实现的接口应该独立成行，保证可读性。
class UserManagerImpl
extends AbstractManager
implements IUserManager{
…
}
9) 方法修饰关键字定义顺序。
注意访问标示符一定要在最前面。
public static double square(double a);
//避免: static public double square(double a);
10) 变量声明，采用Camel 表示法不要在一行声明多个变量。
//推荐
int level;
int size;
//避免
int level, size;
11) 保证明确的类型转换，不要默认进行隐式类型转换
intValue = (int) floadValue; //避免 intValue = floatValue
12) 数组指示符紧跟类型变量
int[] a = new int[20]; //避免: int a[] = new int[20]
一个变量要代表独立的意思，不要在其生命周期赋予它不同的概念。
int tempValue;
tempValue = maxValue;
…
…
tempValue = minValue;
…
tempValue = anotherValue;
tempValue 在生命周期内表示了各种各样的意图，增加理解代码的难度。
应该为每个独立概念定义单独的变量：
int tempMaxValue;
int tempMinValue;
int tempAnotherValue;
13) 仅仅循环控制变量才能出现在for()循环中
sum = 0;
for (i = 0; i < 100; i++) {
sum += value[i];
}
//避免:
for (i = 0, sum = 0; i < 100; i++){
sum += value[i];
}
14) 循环变量应靠近循环体初始化
isDone = false
while(!isDone){
…
}
//避免
isDone = false;
…
…
while(!isDone){
…
}
15) 避免长的布尔表达式，应换成多个更容易理解的表达式。
bool isFinished = (elementNo < 0) || (elementNo > maxElement);
bool isRepeatedEntry = elementNo == lastElement;
if (isFinished || isRepeatedEntry) {
…
}
//避免
if ((elementNo < 0) || (elementNo > maxElement)|| elementNo ==
lastElement) {
…
}
16) 不要在条件语句中执行方法，以提高可读性
InputStream stream = File.open(fileName, "w");
if (stream != null) {
…
}
//避免
if (File.open(fileName, "w") != null)) {
…
}
17) 代码缩进，应该使用4 个空格为一个单位进行缩进。
public String invoke() throws Exception { ....String profileKey = "invoke: ";
try {
....UtilTimerStack.push(profileKey);
if (executed) {
....test = true;
}
}
catch{ }
18) 条件语句的主要形式，即使单条语句，也要使用括号括起来。
if (condition) {
statements;
}
if (condition) {
statements;
} else {
statements;
}
if (condition) {
statements;
} else if (condition) {
statements;
} else {
statements;
}
19) 空循环体也要使用完整的{}块
for (initialization; condition; update) { ;
}
20) switch 语句的使用格式
switch (condition) {
case ABC :
statements;
//穿透，一定要做出注释
case DEF :
statements;
break;
case XYZ :
statements;
break;
default :
statements;
break;
}
21) try-catch 使用格式
try {
statements;
}
catch (Exception exception) { statements;
}
try {
statements;
}
catch (Exception exception) { statements;
}
finally {
statements;
}
22) 空格的使用
1. 运算符两边应该各有一个空格。
2. Java 保留字后面应跟随一个空格。
3. 逗号后面应跟随一个空格。
4. 冒号两个应各有一个空格。
5. 分号后面应跟随一个空格。
a = (
b + c) * d; while (true) { // NOT: a=(b+c)*d
// NOT: while(true){ ...
doSomething(a, b, c, d); // NOT: doSomething(a,b,c,d);
case 100 : // NOT: case 100:
for (i = 0; i < 10; i++) { // NOT: for(i=0;i<10;i++){ ...
23) 空行的使用
1. 文件头部注释、package 语句和import 语句之间。
2. class 之间
3. 方法之间
4. 方法中，变量的申明和具体代码之间。
5. 逻辑上相关的语句段之间
6. 块注释和行注释的前面
▽ --- 代表空行
/**
*
*/
▽
package XXX.XXX;
▽
import XXX.XXX.XXX.XXX;
▽
/**
*
*/
public class UserFileAccess { ▽
//
private int myObjId;
▽
/**
*
*/
public UserFileAccess() {
???
}
▽
/**
*
*/
public void getCtlInfo() { int count;
▽▽String msg;
count = 100;
???
//实现代码注释前空行
msg= “MESSAGE”;
▽
count = dataCount;
if (count == 0) {
???
}
}
▽
/**
*
*/
private class UserFileRead {
24) 逻辑上紧密相关的代码块应该用一个空行分开。
// Create a new identity matrix
Matrix4x4 matrix = new Matrix4x4();
// Precompute angles for efficiency
double cosAngle = Math.cos(angle);
double sinAngle = Math.sin(angle);
//Specify matrix as a rotation transformation matrix.setElement(1, 1, cosAngle);
matrix.setElement(1, 2, sinAngle);
matrix.setElement(2, 1, -sinAngle);
matrix.setElement(2, 2, cosAngle);
// Apply rotation
transformation.multiply(matrix);
25) 为了保证可读性，变量名应该左对齐。
TextFile file;
int nPoints;
double x, y;
//避免
TextFile file;
int nPoints;
double x, y;
26) 像前面一般规则里说的那样，任何提高代码可读性的排版都可以去尝试，
下面是一些例子。
if(a == lowValue) compueSomething();
else if (a == mediumValue) computeSomethingElse();
else if (a == highValue) computeSomethingElseYet();
value = (potential * oilDensity) / constant1 + (depth * waterDensity) / constant2 +
(zCoordinateValue * gasDensity) / constant3;
minPosition = computeDistance(min, x, y, z);
averagePosition = computeDistance(average, x, y, z);
switch (phase) {
case PHASE_OIL : text = "Oil"; break;
case PHASE_WATER : text = "Water"; break;
case PHASE_GAS : text = "Gas"; break;
}
27) 当对if 语句中的条件进行折行时，应该使折行的条件语句相对主功能
语句再行缩进 4 个空格，以突出主要功能语句。
//使用这种缩进，突出主要功能语句。
if ((condition1 && condition2)
|| (condition3 && condition4)
||!(condition5 && condition6)) {
doSomethingAboutIt();
}
//避免使用这种缩进，主功能语句不突出。
if ((condition1 && condition2)
|| (condition3 && condition4)
||!(condition5 && condition6)) {
doSomethingAboutIt();
}
28) 三元条件运算符
可以使用如下三种表达方式，条件要用括号括起来。
alpha = (aLongBooleanExpression) ? beta : gamma;
alpha = (aLongBooleanExpression) ? beta
: gamma;
alpha = (aLongBooleanExpression)
? beta
: gamma
第4章命名规范
4.1一般命名规范
29) 包名应该用小写字母，不要出现下划线等符号，名词用有意义的缩写或
者英文单词。
示例：
//推荐
com.esse.business
https://www.doczj.com/doc/6711718849.html,ng.util
//避免
com.Esse-tech.buSiness
30) 所有类命名使用Pascal 表示方式，使用名词组合。
UserManager, ClassLoader, HttpHeaderResult
31) 接口命名使用字母“I”加上Pascal 形式的表示方式。
IQuery, IDataAccess,IReportBuilder
32) 使用名词组合或形容词去命名一个接口，接口声明了一个对象能提供的
服务，也描述了一个对象的能力。一般以“able”和“ible”作为后缀，
代表了一种能力。
public interface Runn able{
public void run();
}
public interface Access ible{
public Context getContext();
}
33) 变量名和参数名使用Camel 表示方式。
userName, objectFactory, entrys, list
34) 对于常量名，使用大写字母，并使用下划线做间隔。
MAX_TIMES, DEFAULT_NAME
程序中应该使用常量代替“25”，“100”等实际的数字，如：
//推荐
if(times == MAX_TIMES){
…
}
//避免
if(times == 25){
…
}
这样做的好处是，当因需要修改实际的数字时，比如修改25 为30，只需要修改一处。
35) 方法名应该使用动词开头，使用Camel 表示方式,一般由动词+名词组
成。
getName, initialize, addParameter, deleteUser
36) 缩写字母也应该保持首字母大写
export Html Source(); //避免: export HTML Source();
open Dvd Player(); //避免: open DVD Player();
37) 变量的名字应该和类型名称一致
void setTopic(Topic topic) //避免: void setTopic(Topic value)
//避免: void setTopic(Topic aTopic)
//避免: void setTopic(Topic t)
void connect(Database database)
//避免: void connect(Database db)
//避免: void connect(Database oracleDB)
当同时定义多个属于同一个类的变量时，把类型作为实例的后缀，如：Point startPoint;
Point centerPoint;
这样做是为了从实例名就可以推断它的类型名称。
38) 根据变量的作用范围，作用范围大的应该使用长名称，作用范围大，表
明变量的生命周期比较长，为了有助于理解，应尽量用长名称以表达变量的真实意图。反之，对于作用范围小，可以使用一些简化的名称，比如i，j，k 等，提高编程效率。
for(int i =0;i < times; i++){
…
}
4.2特殊命名规范
39) 使用get/set 对类属性进行访问，这是Java 社区的核心编码规范。
40) 使用i s 前缀表示一个布尔变量和方法。
isUsed, isEmpty,isVisible,isFinished
有时也可以使用has，can，should：
boolean hasLicense();
boolean canEvaluate();
boolean shouldAbort = false;
41) 在查询方法中应使用find作为前缀
vertex.findNearestVertex();
matrix.findSmallestElement();
node.findShortestPath(Node destinationNode);
42) 使用initialize 做为对象初始化的方法前缀，也可以简写为init
initializeFiles();
init();
initFontSet();
43) 对于对象集合，变量名称应使用复数。
Collection
int[] values;
44) 对于抽象类，应该使用Abstract 前缀。
AbstractReportBuilder，AbstractBeanFactory
45) 对于表示编号的变量，应加No 后缀。
tableNo, userNo,employeeNo
46) 常在一起使用的对称词汇，这些词汇一起使用，方法的表达意图自然可
以互相推测和演绎。
get/set, add/remove, create/destroy, start/stop, insert/delete, increment/decrement, begin/end, first/last, up/down, min/max, next/previous, old/new, open/close,
show/hide, suspend/resume
47) 避免使用否定布尔变量
bool isError; //避免: isNoError
bool isFound; //避免: isNotFound
48) 异常类应该使用Exception 做为后缀。
AccessException, RuntimeException
49) 缺省接口实现应该使用Default 前缀
class DefaultTableCellRenderer
implements TableCellRenderer {
…
}
50) 对于单例类（Singleton），应该使用getInstance 方法得到单例。
class UnitManager {
private final static UnitManager instance = new UnitManager();
private UnitManager() {
...
}
public static UnitManager getInstance(){
return instance_;
}
}
51) 对于工厂类，进行创建对象的方法，应该使用new 前缀
class PointFactory {
public Point new Point(...) {
...
}
}
第5章注释规范
5.1概述
代码中为什么要包含注释？
1. 别人要调用你的程序中的公共接口，对这部分进行文档描述，使别人能
够正确而有效的使用它。
2. 除了自己，别人要阅读和维护你的代码。为了使代码更容易维护，首先
要使代码更易于理解，才能在理解的基础上进行维护。对这些代码进行
文档描述，将使这个过程变得更加容易。
对代码进行注释，是在代码可读性的基础上，使用自然语言对代码所表达的意思进行阐述。并不是说代码可以写的很烂，注释写的很详细，这不是好的方式。如果代码可读性很好，命名表意丰富，清晰，一般不需要特别多的注释。对于类，主要着重要描述它的职责，即它能干什么，对于复杂的算法实现，应该使用内部实现注释，说明算法的主要思路，对于长方法，要让阅读代码的人比较容易的明白方法实现的主要流程。反之，对于一看就懂的方法，则不需要进行注释，比如get/set 方法。
5.2一般原则
1. 代码应该和注释保持同步，如果代码和注释不同步，则阅读代码的人会
想，“到底是代码准确，还是注释准确啊”，换谁都会糊涂。
2. 注释尽量简洁，尺度没有准确的定义，大部分人能明白即可，可以将自
己的代码给同事看看。太简单的方法就不要注释了，比如上面提到的
get/set 方法。
Java代码规范 1. 标识符命名规范 1.1 概述 标识符的命名力求做到统一、达意和简洁。 1.1.1 统一 统一是指，对于同一个概念，在程序中用同一种表示方法，比如对于供应商，既可以用supplier，也可以用provider，但是我们只能选定一个使用，至少在一个Java项目中保持统一。统一是作为重要的，如果对同一概念有不同的表示方法，会使代码混乱难以理解。即使不能取得好的名称，但是只要统一，阅读起来也不会太困难，因为阅读者只要理解一次。 1.1.2 达意 达意是指，标识符能准确的表达出它所代表的意义，比如：newSupplier, OrderPaymentGatewayService等；而supplier1, service2，idtts等则不是好的命名方式。准确有两成含义，一是正确，而是丰富。如果给一个代表供应商的变量起名是order，显然没有正确表达。同样的，supplier1, 远没有targetSupplier意义丰富。 1.1.3 简洁 简洁是指，在统一和达意的前提下，用尽量少的标识符。如果不能达意，宁愿不要简洁。比如：theOrderNameOfTheTargetSupplierWhichIsTransfered 太长，transferedTargetSupplierOrderName则较好，但是transTgtSplOrdNm就不好了。省略元音的缩写方式不要使用，我们的英语往往还没有好到看得懂奇怪的缩写。 1.1.4 骆驼法则 Java中，除了包名，静态常量等特殊情况，大部分情况下标识符使用骆驼法则，即单词之间不使用特殊符号分割，而是通过首字母大写来分割。比如: supplierName, addNewContract，而不是supplier_name, add_new_contract。 1.1.5 英文vs 拼音
姓名： ____________ 工号：_______________ 部门：____________ 成绩： 一. 判断题(共15题，每题2分，直接在括号内打“/或“X”) 1、任何时候都不要使接口可以序列化。x 2、相对独立的程序块之间、变量说明之后必须加空行。V 3、当程序需要释放对象的时候，应该手工调用fin alize 方法以释放对象。x 4、公司的规范要求注释率是20%以上，并且必须有助于对程序的阅读理解。x 5、为了程序更加简洁，我们应该尽量使用下面的方式来赋值： a = b = 1 。x 6、每个类都需要定义构建器。x 7、类名、方法名、属性名的命名，都应该使用意义完整的英文描述。V 8、main() 方法的定义是public static void main(String args[]) 。x 9、常量名应该使用全大写，英文单词之间用下划线或者-分隔开。并且，常量应该使用final static 修饰。x 10、公有方法参数名可以和属性名相同，但局部变量不能和属性名相同。V 11、一两行代码就能完成的功能没有必要编写方法实现。x 12、对于模块间接口方法的参数的合法性检查，调用者和被调用者都应该对参数进行合法性检查。 x 13、运行期异常使用RuntimeException的子类来表示，必须在方法声明上加throws子句。x非运行 期异常是从Exception继承而来的，不用在可能抛出异常的方法声明上加throws子句。x 14、使用Objectstream 的方法后，调用release()，释放对象。X 15、减小单个方法的复杂度，使用的if, while, for, switch 语句要在10个以内。V 二、单项选择题(共23题，每题2分) (c ) 1、排版时，代码缩进应该采用的方式是： (A)Tab缩进 (B)2个空格缩进
1 Java 编程规范 1.1 排版 1.1.1 规则 规则1程序块要采用缩进风格编写，缩进的空格数为4个，不允许使用TAB缩进。(1.42+) 说明：缩进使程序更易阅读，使用空格缩进可以适应不同操作系统与不同开发工具。 规则2分界符（如大括号…{?和…}?）应各独占一行，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序 或者static、,synchronized等语句块中都要采用如上的缩进方式。(1.42+) 示例: if (a>b) { doStart(); } 规则3较长的语句、表达式或参数（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐， 语句可读。(1.42+) 示例： if (logger.isDebugEnabled()) { logger.debug("Session destroyed,call-id" + event.getSession().getCallId()); } 规则4不允许把多个短语句写在一行中，即一行只写一条语句(1.42+) 说明：阅读代码更加清晰 示例：如下例子不符合规范。 Object o = new Object(); Object b = null; 规则5if, for, do, while, case, switch, default 等语句自占一行，且if, for, do, while,switch等语句的执行语句无论多少都要加括号{},case 的执行语句中如果定义变量必须加括号{}。 (1.42+) 说明：阅读代码更加清晰，减少错误产生 示例： if (a>b) { doStart(); }
Java编程规范本文引用阿里Java开发手册。GitHub阅读地址： 目录 编程规约 - 命名规约 - 常量定义 - 格式规范 - OOP规约 - 集合处理 - 并发处理 - 控制语句 - 注释规约 - 其他 - 异常处理 - 建表规约 - 索引规约 - SQL规约
- ORM规约 编程规约 命名规约 1、【强制】所有编程相关命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束 反例： _name / __name / $Object / name_ / name$ / Object$1 2、【强制】所有编程相关的命名严禁使用拼音与英语混合的方式，更不允许直接使用中的方式。 说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即纯拼音的命名方式也要避免采用。 反例： DaZhePromotion [打折] / getPingfenByName() [评分] / int 变量 = 3; 正例： ali / alibaba / taobao / cainiao / aliyun / youku / hangzhou 等国际通用的名称，可视为英文。12345 3、【强制】类名使用 UpperCamelCase 风格，必须遵从驼峰形式，但以下情形例外：（领域模型的相关命名） DO / DTO / VO / DAO 等。 正例： MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion 反例： macroPolo / UserDo / XMLService / TCPUDPDeal
/ TAPromotion123 4、【强制】方法名、参数名、成员变量、局部变量都统一只用 lowerCamelCase 风格，必须遵从驼峰形式。 正例： localValue / getHttpMessage() / inputUserId1 5、【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。 正例： MAX_STOCK_COUNT 反例： MAX_COUNT123 6、【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。 7、【强制】中括号是数组类型的一部分，数组定义如下：String[] args ; 反例：请勿使用 String args[] 的方式来定义1 8、【强制】 POJO 类中的任何布尔类型的变量，都不要加 is，否则部分框架解析会引起序列化错误。 反例：定义为基本数据类型 boolean isSuccess；的属性，它的方法也是 isSuccess()， RPC框架在反向解析的时候，“以为”对应的属性名称是 success，导致属性获取不到，进而抛出异常。1 9、【强制】包名统一使用小写，点分隔符之间有且仅有一
Java开发规范
目录 第1章序言 (4) 第2章java一般性研发规范 (5) 2.1 代码格式 (5) 2.1.1包、类、方法的命名规范: (5) 2.1.2方法的命名应注意避免与java中具有特殊意义的名称例如equals， hashCode，clone，finalizer等冲突 (7) 2.1.3Java bean中取得boolean类型的属性值必须使用is****形式命名 (9) 2.1.4if,else,while,for等必须使用{} (9) 2.1.5类必须包含在包里，禁止出现无包的类 (10) 2.1.6类和方法必须拥有注释，注释量占总体代码25%以上，类头部，以及方法 头部的注释应符合javadoc标准。 (11) 2.2 基本语法 (12) 2.2.1不能随意捕捉异常，原则上谁捕捉谁处理 (12) 2.2.2if，while，try，finally，switch ，synchronized ，static instantiation 里面应有相应的逻辑处理，不能为空。 (13) 2.2.3在处理循环中，不能在程序中人为的改变步长。 (14) 2.2.4将简单类型int，short，float，double等转化成字符串时，需使用其对 应类的toString方法。 (14) 2.2.5javaBean中hashCode，以及equals方法必须同时override。 (15) 2.2.6懒式方式创建对象：不能采用双检查惯用法 (18) 2.2.7不能在finally中返回值。 (19) 2.2.8Boolean实例化时，应用使用Boolean.valueOf，Boolean.TRUE， Boolean.FALSE。 (19) 2.2.9Integer,Byte,Short,Long等实例化时，应用使用valueOf (20) 2.2.10对于多个if语句嵌套的情况下能够整合尽量整合。 (20) 2.2.11override function，不能只有super.function语句，否则视为无效代码 21 2.2.12Collection.toArray的注意事项。 (21) 2.2.13对于BigDecimal方法，应避免使用float值，double值进行创建，应使 用字符串形式创建。 (22) 2.2.14String,BigDecimal,BigInteger等值类型调用replace，add等方法的注 意事项。 (23) 2.2.15需要注意的引起NullException的语句。 (23) 2.2.16ResultSet使用next时，需要判断是否具有记录再进行一下步操作。 25 2.2.17字符串使用相应的规则。 (25) 2.2.18禁止直接调用 System.gc(),System.getRuntime().gc(),System.runFinalization()。 (27) 2.2.19finalize相应的规则。 (27) 2.2.20禁止在代码中使用System.out,ex.printStackTrace打印日志。 (28) 2.2.21系统资源释放（谁创建的，谁关闭） (29) 2.2.22使用Clone时相应的规则。 (32) 2.2.23java Bean类必须实现Serialize接口。 (33)
Java语言编码规范 Prepared by 拟制Date 日期 yyyy-mm-dd Reviewed by 评审人Date 日期 yyyy-mm-dd Approved by 批准Date 日期 yyyy-mm-dd
Revision Record 修订记录
Table of Contents 目录 1. 范围 (4) 2. 规范性引用文件 (4) 3. 术语和定义 (4) 4. 排版规范 (5) 4.1. 规则 (5) 4.2. 建议 (7) 5. 注释规范 (9) 5.1. 规则 (9) 5.2. 建议 (15) 6. 命名规范 (17) 6.1. 规则 (17) 6.2. 建议 (18) 7. 编码规范 (20) 7.1. 规则 (20) 7.2. 建议 (24) 8. JTEST规范 (26) 8.1. 规则 (26) 8.2. 建议 (27)
1.范围 本规范规定了使用Java语言编程时排版、注释、命名、编码和JTEST的规则和建议。 本规范适用于使用Java语言编程的产品和项目。 2.规范性引用文件 下列文件中的条款通过本规范的引用而成为本规范的条款。凡是注日期的引用文件，其随后所有的修改单（不包括勘误的内容）或修订版均不适用于本规范，然而，鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本规范。 3.术语和定义 规则：编程时强制必须遵守的原则。 建议：编程时必须加以考虑的原则。 格式：对此规范格式的说明。 说明：对此规范或建议进行必要的解释。 示例：对此规范或建议从正、反两个方面给出例子。
一、单选题 1. 如下关于集合类的描述错误的是B A. 含有集合意义的属性命名，尽量包含其复数的意义 B. 集合中的数据不需要释放，垃圾回收器会自动回收 C. 集合必须指定模板类型 D. 使用集合类时要设置初始化容量 2. 关于线程以下说法错误的有B A. 新起一个线程，都要使用Thread.setName(“…”)设置线程名 B. 在JDK1.5或更新的版本中，若字符串拼接发生在单线程环境，使用StringBuffer C. 对多线程访问的变量、方法，必须加锁保护，避免出现多线程并发访问引起的问题 D. 线程使用时，要在代码框架中使用线程池，避免创建不可复用的线程；禁止在循环中创建新线程，否则会引起JVM资源耗尽 3. 下面哪个是推荐使用的对称密码算法B A. DES B. AES C. SHA D. RSA
4. 以下说法正确的有C A. 程序中的一些状态多直接用数字表示，如函数执行成功return 1 B. 对于表示函数执行错误，多用约定的错误码来标识 C. 用有意义的静态变量或者枚举来代替数字型的程序状态，如函数执行成功return SUCCESS D. 程序中的魔鬼数字并不可怕，需要所有开发人员努力理解这些数字的含义 5. 下列错误使用异常的做法是D A. 在程序中使用异常处理还是使用错误返回码处理，根据是否有利于程序结构来确定，并且异常和错误码不应该混合使用，推荐使用异常 B. 一个方法不应抛出太多类型的异常。throws/exception子句标明的异常最好不要超过三个 C. 异常捕获尽量不要直接catch (Exception ex)，应该把异常细分处理 D. 程序内抛出的异常本身就可说明异常的类型、抛出条件，可不填写详细的描述信息。捕获异常后用exception.toString()取到详细信息后保存 6. 关于命名规范，以下说法错误的有D A. 属性名使用意义完整的英文描述，第一个单词的字母使用小写，剩余单词首字母大写其余字母小写的大小写混合法。属性名不能与方法名相同 B. 方法名使用类意义完整的英文描述：第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法 C. 方法中，存取属性的方法采用setter 和getter方法，动作方法采用动词和动宾结构
JAVA代码规范 (初稿) 2004、4 ?版本更新信息 本版本创建/修改、维护、批准涉及人员如下： 创建/修改者：XX 维护者：XX 批准者：XX 具体版本更新记录如表1-1： 表1-1 版本更新记录 修改方式：A－增加 M－修改 D－删除?目得 本文提供一整套编写高效可靠得 Java 代码得标准、约定与指南。它们以安全可靠得软件工程原则为基础，使代码易于理解、维护与增强灵活性。通过遵循一套通用得程序设计标准，显著提高 Java 软件开发者得生产效率，为开发团队得程序设计带来更大得一致性，使软件开发团队得效率明显提高。 ?规范得执行 本文档适用于公司内进行软件开发得所有技术人员，即公司内软件开发人员编写得所有源代码都必须遵循本规范。 除临时性项目之外得任何项目均应严格按照此标准执行，“临时性项目”指：?为市场推广目得而编写得示程序 ?为一次性用途而编写得临时性小程序 为学习目得而编写得测试程序 ?文档类别
本文档属标准规范类得项目限制级文档，未经总经理及总经理授权人员批准，不得提供公司以外得人员阅读与使用。 ?版本更新条件 本文档得定期评审时间为每年得1月，评审及修订步骤依据SEPG工作规范规定。此外，如遇下列条件可进行评审，并根据评审结果决定就是否需要进行修订： ?本文档所列得引用得标准已经更新。 ?本文档得使用者若对本文档有任何评论、建议或意见，请通过企业内部网络发电子邮件给SEPG，所收到得电子邮件将会在评审与修订时给予充分 得考虑。 ?使用对象 本文档得使用对象包括： ?项目管理者 ?质量保证人员 ?软件开发人员 目录 1介绍 (4) 1、1为什么要有编码规范 (4) 2通用代码格式 (4) 2、1文件组织 (4) 2、2缩进 (5) 2、3行长度 (6) 2、4换行 (6) 2、5空行 (7) 2、6空格 (7) 2、7注释 (8) 2、7、1注释约定 (8) 2、7、2实现注释得格式 (9) 2、7、3文档注释 (10) 2、7、4快速浏览javadoc (10) 2、8声明 (11) 2、8、1每行声明变量得数量 (11) 2、8、2初始化 (11) 2、8、3布局 (11) 2、8、4类与接口得声明 (12) 2、9语句 (12) 2、9、1简单语句 (12) 2、9、2复合语句 (13) 2、9、3返回语句 (13) 2、9、4if，if-else，if else-if else语句 (13)
多选 1.如何处理单元测试产生的数据，下列哪些说法是正确的？ABC A .测试数据入库时加特殊前缀标识。 B .测试数据使用独立的测试库。 C .自动回滚单元测试产生的脏数据。 D .无须区别，统一在业务代码中进行判断和识别。 多选 2.关于并发处理，下列哪些说法符合《阿里巴巴Java开发手册》：ABC A .线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。 B .同步处理时，能锁部分代码区块的情况下不要锁整个方法；高并发时，同步调用应该考虑到性能损耗。 C .创建线程或线程池时，推荐给线程指定一个有意义的名称，方便出错时回溯。 D .推荐使用Executors.newFixedThreadPool(int x)生成指定大小的线程池。(线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方式) 多选 3.下列哪些说法符合《阿里巴巴Java开发手册》：ACD A .对于“明确停止使用的代码和配置”，如方法、变量、类、配置文件、动态配置属性等要坚决从程序中清理出去，避免造成过多垃圾。 B .永久弃用的代码段注释掉即可，即不用加任何注释。 C .对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三个斜杠(///)来说明注释掉代码的理由。 D .不要在视图模板中加入任何复杂的逻辑。 多选 4.关于分页查询，下列哪些说法符合《阿里巴巴Java开发手册》：ABC A .分页查询，当统计的count为0时，应该直接返回，不要再执行分页查询语句。 B .iBATIS自带的queryForList(String statementName,int start,int size)分页接口有性能隐患，不允许使用。 C .定义明确的sql查询语句，通过传入参数start和size来实现分页逻辑。 D .可使用存储过程写分页逻辑，提高效率。
JAVA编程规范--试题 姓名：工号：部门：成绩： 一. 判断题（共15题，每题2分，直接在括号内打“√”或“×”） 1、任何时候都不要使接口可以序列化。x 2、相对独立的程序块之间、变量说明之后必须加空行。√ 3、当程序需要释放对象的时候，应该手工调用finalize方法以释放对象。x 4、公司的规范要求注释率是20％以上，并且必须有助于对程序的阅读理解。x 5、为了程序更加简洁，我们应该尽量使用下面的方式来赋值：a = b = 1 。x 6、每个类都需要定义构建器。x 7、类名、方法名、属性名的命名，都应该使用意义完整的英文描述。√ 8、main() 方法的定义是public static void main(String args[])。x 9、常量名应该使用全大写，英文单词之间用下划线或者-分隔开。并且，常量应该使用 final static修饰。x 10、公有方法参数名可以和属性名相同，但局部变量不能和属性名相同。√ 11、一两行代码就能完成的功能没有必要编写方法实现。x 12、对于模块间接口方法的参数的合法性检查，调用者和被调用者都应该对参数进行合 法性检查。x 13、运行期异常使用RuntimeException的子类来表示，必须在方法声明上加throws子句。 x非运行期异常是从Exception继承而来的，不用在可能抛出异常的方法声明上加throws 子句。x 14、使用ObjectStream 的方法后，调用release() ，释放对象。X 15、减小单个方法的复杂度，使用的 if, while, for, switch 语句要在10个以内。√ 二、单项选择题(共23题，每题2分) （ c ）1、排版时，代码缩进应该采用的方式是： （A）Tab缩进 （B）2个空格缩进 （C）4个空格缩进 （D）8个空格缩进
命名规范： 1.所有的标识都只能使用ASCII字母（A-Z或a-z）、数字（0-9）和 下划线”_”。 2.一个唯一包名的前缀总是用全部小写的字母。 3.类名是一个名词，采用大小写混合的方式，每个单词的首字母大 写。 4.接口的大小写规则与类名相似。 5.方法名是一个动词或是动词词组，采用大小写混合的方式，第一 个单词的首字母小写，其后单词的首字母大写。 6.变量名的第一个字母小写，任何中间单词的首字母大写，变量名 应简短且可以顾名思义，易于记忆。避免单个字符的变量名，除非是一次性的临时变量。 7.常量的声明应该全部大写，每个单词之间用”_”连接。 注释规范： 1.注释尽可能使用”//”,对于所有的Javadoc的注释使用/***/，而 临时对代码块进行注释应尽量使用/**/。 2.所有的源文件都应该在开头有一个注释，其中列出文件名、日期 和类的功能概述。每个方法必须添加文档注释（main除外）。 3.每个属性必须加注释。 4.代码中至少包含15%的注释。 5.注释使用中文。
缩进排版规范： 1.避免一行的长度超过60个字符。 2.使用Eclipse源代码的格式化功能完成代码的缩进排版。 文件名规范： 1.一个Java源文件只能储存一个Java类。 2.文件名与Java类相同。 3.一个类文件不超过200行。 声明规范： 1.一行声明一个变量。 2.不要将不同类型变量的声明放在同一行。 3.只在代块的开始处声明变量。 4.所有的变量必须在声明时初始化。 5.避免声明的局部变量覆盖上一级声明的变量。 6.方法与方法直接以空行分隔。 语句规范： 1.每行至少包含一条简单语句。 2.在return语句中，返回值不使用小括号”()”括起来。 3.If月总是用{和}括起来。 4.在for语句的初始化或者更新子句中，避免因使用3个以上变量， 而导致复杂度提高。 5.当switch的一个case顺着往下执行时（因为没有break），通常 应在break语句的位置添加注释。
1.程序块采用缩进风格,空格为4个. 说明: 对于开发工具自动生成的代码可以不一致 2.分界符(如大括号{和})应各自占一行并且在同一列,同时与引用它们的语句左 对齐,在方法的开始,类和接口的定义,以及if,for,do,while,switch,case语句都要采用上述缩进 说明: for(…) { …//your code } 3.较长(>80字符)的语句,表达式和参数要分多行,长表达式要在低优先级操作符 划分新行,操作符放在行首,新行要适当缩进,整齐,语句可读. 说明: if(filename != null && new File(logPath+filename).length() < logConfig.getFileSize()) { …//your code } 4.一行只写一条语句 说明: LogFilename wow = null; LogFilename that = null; 5.if,for,do,switch,while,case,default各占一行,它们的执行语句无论多少都要加{} 说明: if(writeToFile) { writeFileThread.interrupt(); } 6.相对独立的程序块,变量,说明要加空行 说明: if(log.getLevel() < log.getRecord()) { return ; } //空行
LogWrite writer; 7.对齐只用空格键,不用TAB键 说明: 以免使用不同的编辑器阅读程序时,因TAB键所设置的空格数不同而造成程序布局不整齐,JBuildr,UltraEdit等编辑环境,支持行首TAB替换成空格,应将该选项打开 8.两个以上的关键字,变量,常量进行对等操作时,操作符之前,之后或前后要加空 格,进行非对等操作时,如果是关系密切的立即操作符,后面不加空格(如.操作符) 说明: 采用这种松散方式编写代码目的是让程序更加清晰,由于空格所产生的清晰性是相对的,所以在已经很清晰的语句中没有必要留空格,如果语句已足够清晰,则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为java中括号已经是很清晰的标志了.在长句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部中不加空格,给操作符留空格时不要连续留两个以上空格 9.类属性和方法不要交叉放置,不同存取范围的属性和方法也不要交叉放置 说明: 类定义:{ 类公有属性定义; 类保护属性定义; 类私有属性定义; 类公有方法定义; 类保护方法定义; 类私有方法定义; } 10.源程序的有效注释量必须在30%以上 11.包的注释写入一个名为package.html的html格式的说明文件放入当前路径 12.包的注释内容:本包作用,详细描述本包内容,产品模块名称及版本,公司版本 说明:
一句话描述 详细描述 产品模块Java编程规范 目录 Java编程规范 (1) 1编码规则 (1) 2命名规范 (7) 2.1类名、变量名（非final）、方法名 (7) 2.2驼峰式命名 (7) 2.3不能使用没有任何含义的英文字母进行命名 (7) 2.4不能使用拼音进行命名，统一使用准确的英文进行命名 (8) 2.5包名 (8) 2.6接口与类的命名 (8) 2.7抽象类命名 (8) 2.8实现类命名 (8) 2.9工具类命名 (8) 2.10变量命名 (8) 2.115、方法命名 (9) 2.12系统的命名约定 (9) 1编码规则 1、数据库操作、IO操作等需要使用结束close()的对象必须在try -catch-finally 的finally中close()，如果有多个IO对象需要close()，需要分别对每个对象的close()方法进行try-catch,防止一个IO对象关闭失败其他IO对象都未关闭。 手动控制事务提交也要进行关闭，对大对象进行关闭操作 示例： try { // ... ... } catch(IOException ioe) { //... ... } finally { try { out.close();
} catch(IOException ioe) { //... ... } try { in.close(); } catch(IOException ioe) { //... ... } } 2、系统非正常运行产生的异常捕获后，如果不对该异常进行处理，则应该记录日志。 说明：此规则指通常的系统非正常运行产生的异常，不包括一些基于异常的设计。若有特殊原因必须用注释加以说明。 logger.error(ioe，“[类.方法]描述”,参数); 示例： try { //.... ... } catch(IOException ioe) { logger.error(ioe); } 3、自己抛出的异常必须要填写详细的描述信息。 说明：便于问题定位。 示例： throw new IOException("Writing data error! Data: "+ data.toString()); 4(删除)、在程序中使用异常处理还是使用错误返回码处理，根据是否有利于程序结构来确定，并且异常和错误码不应该混合使用，推荐使用异常。 说明： 一个系统或者模块应该统一规划异常类型和返回码的含义。 但是不能用异常来做一般流程处理的方式，不要过多地使用异常，异常的处理效率比条件分支低，而且异常的跳转流程难以预测。
JAVA代码规范 本Java代码规范以SUN的标准Java代码规范为基础，为适应我们公司的实际需要，可能会做一些修改。本文档中没有说明的地方，请参看SUN Java标准代码规范。如果两边有冲突，以SUN Java标准为准。 1. 标识符命名规范 1.1 概述 标识符的命名力求做到统一、达意和简洁。 1.1.1 统一 统一是指，对于同一个概念，在程序中用同一种表示方法，比如对于供应商，既可以用supplier，也可以用provider，但是我们只能选定一个使用，至少在一个Java项目中保持统一。统一是作为重要的，如果对同一概念有不同的表示方法，会使代码混乱难以理解。即使不能取得好的名称，但是只要统一，阅读起来也不会太困难，因为阅读者只要理解一次。 1.1.2 达意 达意是指，标识符能准确的表达出它所代表的意义，比如：newSupplier, OrderPaymentGatewayService等；而supplier1, service2，idtts等则不是好的命名方式。准确有两成含义，一是正确，而是丰富。如果给一个代表供应商的变量起名是order，显然没有正确表达。同样的，supplier1, 远没有targetSupplier意义丰富。 1.1.3 简洁 简洁是指，在统一和达意的前提下，用尽量少的标识符。如果不能达意，宁愿不要简洁。比如：theOrderNameOfTheTargetSupplierWhichIsTransfered 太长，transferedTargetSupplierOrderName则较好，但是transTgtSplOrdNm就不好了。省略元音的缩写方式不要使用，我们的英语往往还没有好到看得懂奇怪的缩写。 1.1.4 骆驼法则 Java中，除了包名，静态常量等特殊情况，大部分情况下标识符使用骆驼法则，即单词之间不使用特殊符号分割，而是通过首字母大写来分割。比如: supplierName, addNewContract，而不是supplier_name, add_new_contract。
代码规范要求 为保证我公司研发代码的规范性、可读性，特制定该代码规范： 1、代码应遵循国际java代码规范 2、代码中所有switch（param）{case int：break；}中case 参数应该为在类开始时定义的字符串，以增加后续研发中的可读性。例：private final int company=0; switch(param){case company:break;}不允许出现case0，case1等字样。 3、在对数据库进行大量数据读取时，应采用jdbc方式读取。以增快响应速度，减少内存消耗。数据量超过万单位时必须采用jdbc读取数据库，且应分页读取数据库。 4、方法作用必须注释，方法中传递的参数应该有注释，全局变量，局部变量都应有注释，以说明变量的意义。如方法会被多次调用，或应对二次开发则应注明返回值例：return Boolean true成功false失败； 5、代码中应该采用try catch捕获异常，且应该处理常见异常。 6、代码呈现页面不能出现null字样。 7、代码测试应用及所需捕获异常或输出信息应该采用log4j 进行输出。杜绝出现System.out.println();字样 8、代码不应出现重复定义，同一方法不能多次调用数据库，
如一个方法中需要多次调用数据库则应拆分为两个或多个。 9、同一方法中代码量超过50行则应进行拆分。 10、代码应该采用format格式化。 11、代码已经提交或二次开发时，应注明修改时间修改人修改原因修改后提交参数的内容 12、在未进行实例化的参数判断是否为空时，应该null在前例：if(null!=param) 13、在判断变量是否为空时，尽量避免采用if else应采用Parame==null?”0”:parame;进行判断赋值 14、代码应遵循可读性原则，不能出现过于冗长的代码。 15、多次在不同类中反复调用且内容相同的方法，应该写到公用代码中进行调用。 16、已经失效，且不会被调用的代码应该注销、删除。 17、代码在未经测试时，不要进行提交，以免造成现调用的其他类出现错误。 18、项目的配置文档应该遵循规范格式，尽量增加注释。 19、页面中的js脚本应该具备可读性、增加注释。Js脚本的规范遵从国际js规范。 20、页面中提交的必要的变量参数应该有验证。 21、页面提交的信息或执行时间较长、页面上传文档时应该提示用户正在执行等字样。 22、页面ext的方法复写定义应该在项目中为唯一，不得出
Java代码规范 本Java代码规范以SUN的标准Java代码规范为基础，为适应我们公司的实际需要，可能会做一些修改。本文档中没有说明的地方，请参看SUN Java标准代码规范。如果两边有冲突，以SUN Java标准为准。 1. 标识符命名规范 1.1 概述 标识符的命名力求做到统一、达意和简洁。尽量做到每个人按照规范来，多人开发如一人开发一样。 1.1.1 统一 统一是指，对于同一个概念，在程序中用同一种表示方法，比如对于供应商，既可以用supplier，也可以用provider，但是我们只能选定一个使用，至少在一个Java项目中保持统一。统一是作为重要的，如果对同一概念有不同的表示方法，会使代码混乱难以理解。即使不能取得好的名称，但是只要统一，阅读起来也不会太困难，因为阅读者只要理解一次。 1.1.2 达意 达意是指，标识符能准确的表达出它所代表的意义，比如：newSupplier, OrderPaymentGatewayService等；而supplier1, service2，idtts等则不是好的命名方式。准确有两成含义，一是正确，而是丰富。如果给一个代表供应商的变量起名是order，显然没有正确表达。同样的，supplier1, 远没有targetSupplier意义丰富。 1.1.3 简洁 简洁是指，在统一和达意的前提下，用尽量少的标识符。如果不能达意，宁愿不要简洁。比如：theOrderNameOfTheTargetSupplierWhichIsTransfered 太长，transferedTargetSupplierOrderName则较好，但是transTgtSplOrdNm就不好了。省略元音的缩写方式不要使用，我们的英语往往还没有好到看得懂奇怪的缩写。 1.1.4 骆驼法则
1. Java 命名约定 除了以下几个特例之外,命名时应始终采用完整的英文描述符。此外,一般应采用小写字母,但类名、接口名以及任何非初始单词的第一个字母要大写。 1.1一般概念 n 尽量使用完整的英文描述符 n 采用适用于相关领域的术语 n 采用大小写混合使名字可读 n 尽量少用缩写,但如果用了,要明智地使用,且在整个工程中统一 n 避免使用长的名字(小于 15个字母是个好主意 n 避免使用类似的名字,或者仅仅是大小写不同的名字 n 避免使用下划线(除静态常量等 1.2示范 包(Package采用完整的英文描述符,应该都是由小写字母组成。对于全局包,将你的 Internet 域名反转并接上包名。 j ava.aw t,com.ambysof t.www.persistence 类(Class采用完整的英文描述符,所有单词的第一个字母大写。 Customer, SavingsAccount 接口(Interface采用完整的英文描述符说明接口封装,所有单词的第一个字母大写。习惯上,名字后面加上后缀 able, ible 或者 er,但这不是必需的。Contactable,Prompter 组件/部件(Component使用完整的英文描述来说明组件的用途,末端应接上组件类型。 okButton, customerList,f ileMenu 异常(Exception通常采用字母 e 表示异常。 e
类变量字段采用完整的英文描述,第一个字母小写,任何中间单词的首字母大写。 firstName, lastName 实参/参数同字段/属性的命名规则 public void setFirstName(String firstName{ this.firstName = f irstName;} 局部变量同字段/属性的命名规则 获取成员函数被访问字段名的前面加上前缀 get。 getFirstName(, getLastName( 布尔型的获取成员函数所有的布尔型获取函数必须用单词 is做前缀。isPersistent(, isString( 设置成员函数被访问字段名的前面加上前缀 set。 setFirstName(, setLastName(,setWarpSpeed( 普通成员函数采用完整的英文描述说明成员函数功能,第一个单词尽可能采用一个生动的动词,第一个字母小写。 openFile(, add Account( 静态常量字段(static final全部采用大写字母,单词之间用下划线分隔。 MIN_B ALANCE, DEF AULT_DATE 循环计数器通常采用字母 i,j,k 或者 counter 都可以接受。 i, j, k, counter 数组数组应该总是用下面的方式来命名:obj ectType[]。 byte[] buff er; 2. Java 注释约定 一个很好的可遵循的有关注释的经验法则是:问问你自己,你如果从未见过这段代码,要在合理的时间内有效地明白这段代码,你需要哪些信息。 2.1. 一般概念 n 注释应该增加代码的清晰度
Java开发工作规范
目录 1文档介绍 (4) 1.1文档目的与背景 (4) 1.2文档范围 (4) 1.3参考文献 (4) 1.4术语与缩写解释 (4) 2命名及通用约定规范 (4) 2.1源文件结构规范 (4) 2.1.1Web项目主要目录结构 (4) 2.2J AV A包命名规范 (5) 2.2.1web层 (5) 2.2.2manager层 (6) 2.2.3dao层 (6) 2.2.4单元测试包 (7) 2.3J AV A类及接口命名规范 (7) 2.3.1web层 (7) 2.3.2manager层 (7) 2.3.3dao层 (8) 2.3.4单元测试类 (8) 2.4J AV A方法命名规范 (8) 2.4.1web层 (8) 2.4.2manager层 (9) 2.4.3dao层 (11) 2.4.4单元测试 (11) 2.5J AV A方法返回值规范 (11) 2.6J AV A变量命名规范 (12)
2.7J AV A常量命名规范 (12) 2.8URL映射注解规范 (12) 2.9JSP文件命名规范 (13) 2.9.1JSP文件夹 (13) 2.9.2JSP文件 (14) 3JAVA代码风格规范 (14) 3.1代码格式 (14) 3.2注释 (15) 3.2.1注释类型 (15) 3.2.2注释的格式 (17) 3.2.3注释的内容 (18) 3.3变量声明及初始化 (19) 3.3.1每行声明变量的数量 (19) 3.3.2初始化 (20) 3.4语句 (20) 3.4.1简单语句 (20) 3.4.2复合语句 (20) 3.4.3返回语句 (21) 3.4.4if，if-else，if else-if else语句 (21) 3.4.5for语句 (22) 3.4.6while语句 (22) 3.4.7do-while语句 (23) 3.4.8switch语句 (23) 3.4.9try-catch语句 (24) 3.5空白 (24) 3.5.1空行 (25) 3.5.2空格 (25) 4单元测试规范 (26)
软件开发代码规范（C）（仅通普信息技术股份有限公司供内部使用） 黑龙江通普信息技术股份有限公司 版本历史
目录 第一章代码开发规范及其指南 (1) 1.1 目的 (1) 1.2 程序内命名规范 (1)
1.3 文件命名规范 (2) 1.4 J AVA文件样式 (2) 1.5 代码编写格式 (6) 第二章程序编写规范方法 (8) 2.1 权限修饰 (8) 2.2 其他规范 (8) 2.3 编程指南 (10) 第三章其他要求 (12)
第一章代码开发规范及其指南 1.1 目的 定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性） 1.2 程序内命名规范 Package的命名：Package的名字应该都是由一个小写单词组成。 Class 的命名：Class 的名字必须由大写字母开头而其他字母都小写的单词组成Class变量的命名：变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。 Static Final 变量的命名：Static Final 变量的名字应该都大写，并且指出完整含义。 参数的命名：参数的名字必须和变量的命名规范一致。 数组的命名：数组应该总是用下面的方式来命名：byte[] buffer; 而不是byte buffer[]; 方法的参数：使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字： SetCounter(int size){ this.size = size; }
1.3文件命名规范 文件名由英文单词组成，每个单词的首字母大写，不要超过4个单词, 如ShipOrder.jsp Java文件的文件名要与程序中的public类名相同。 Servet文件要以Servlet做为结尾，如AddCompanyServlet.java 业务处理组 件Java Bean要以Bean为结尾，如ProcessBean.java 1.4 Java文件样式 所有的Java(*java)文件都必须遵守如下的样式规则 头部 版权信息 版权信息必须在java文件的开头，比如： 其他不需要出现在javadoc的信息也可以包含在这里。 Package/lmports package行要在import行之前，import中标准的包名要在本地的包名之前，而且按照字母顺序排列。如果import行中包含了同一个包中的不同子目 录，则应该用*来处理。 package hotlava .n et.stats; import java.io.*; import java.util.Observable; import hotlava.util.Applicati on;