Coding Standard-JavaZUSTSoftwareInstitute
Coding Standard - Java ZUST Software Institute
编码通则一一文件头·每个文件必须要有文件头/*** Copyright 2006 by IBM. All rights reserved.*Description:*Fixed Bugs:大iBM-20901112006-10-01fixedbyjack*Prepared by DavidPage 2
Prepared by David Page 2 编码通则 ——文件头 /** * Copyright 2006 by IBM. All rights reserved. * Description: . * Fixed Bugs: * iBM-2090111 2006-10-01 fixed by jack */ •每个文件必须要有文件头
编码通则一一注释注释表述代码本身不能提供的额外信息。注视包括帮助阅读和理解程序的文字，避免穴余或无用的信息。注释要与所说明语句保持相同的缩进·问题点修改注释写在文件头中PreparedbyDavidPage 3
Prepared by David Page 3 编码通则 —— 注释 •注释表述代码本身不能提供的额外信息。注视包 括帮助阅读和理解程序的文字，避免冗余或无用 的信息。 •注释要与所说明语句保持相同的缩进。 •问题点修改注释写在文件头中
编码通则一一注释publicstaticStringformatlnteger(intnum,intlength)Stringnumber=(newInteger(num).toString();I根据长度循环在数字前面补“0”。while(number.length0)<length)number="o"+number;returnnumber;publicstaticStringformatlnteger(intnum,intlength)Stringnumber=(newInteger(num).toString();根据长度循环在数字前面补“0”while(number.length()<length)number="o"+number;returnnumber,Prepared byDavidPage 4
Prepared by David Page 4 编码通则 —— 注释 public static String formatInteger(int num, int length) { String number = (new Integer(num)).toString(); //根据长度循环在数字前面补“0”。 while (number.length() < length) { number = "0" + number; } return number; } public static String formatInteger(int num, int length) { String number = (new Integer(num)).toString(); //根据长度循环在数字前面补“0”。 while (number.length() < length) { number = "0" + number; } return number; }
编码通则一缩进·同一个文件中使用统一的缩进，统一使用四个空格或使用四个空格宽度的制表符（与工具有关，在ultraedit中一个tab是两个空格，在word中是四个空格publicstaticStringformatinteger(intnum,intlength)Stringnumber=(newlnteger(num).toString();根据长度循环在数字前面补“0”。while(number.length(<length)number="o"+number;?returnnumber:publicstaticStringformatinteger(intnum,int length)Stringnumber=(newInteger(num)).toString();根据长度循环在数字前面补“0”while(number.length(<length)number="o"+number,returnnumber;PreparedPage 5
Prepared by David Page 5 编码通则 —— 缩进 public static String formatInteger(int num, int length) { String number = (new Integer(num)).toString(); //根据长度循环在数字前面补“0”。 while (number.length() < length) { number = "0" + number; } return number; } public static String formatInteger(int num, int length) { String number = (new Integer(num)).toString(); //根据长度循环在数字前面补“0”。 while (number.length() < length) { number = "0" + number; } return number; } • 同一个文件中使用统一的缩进，统一使用四个空格 或使用四个空格宽度的制表符 （与工具有关，在 ultraedit中一个tab是两个空格，在word中是四个空格）
编码通则空行下列情况使用两个空行：·在类和接口的定义之间下列情况使用单个的空行：·两个方法之间：方法内的局部变量和第一个语句之间；块注释和行注释之间；方法内的逻辑节之间。Prepared byDavidPage 6
Prepared by David Page 6 编码通则 ——空行 下列情况使用两个空行： •在类和接口的定义之间。 下列情况使用单个的空行： •两个方法之间； •方法内的局部变量和第一个语句之间； •块注释和行注释之间； •方法内的逻辑节之间
编码通则一一空行class Catclass Cat(private int catNumber;private int catNumber;Cat(int i)Cat(int i)catNumber=i;catNumber=i;Apublic intgetNumberopublicintgetNumberointtmpNumber;inttmpNumber;if(catNumber>0)tmpNumber=catNumber;if (catNumber>0)tmpNumber=catNumber;System.out.printin("...");7System.out.println".");1classDogimplementsComparable(private int dogNumber;Dog(inti)classDogimplementsComparabledogNumber=i;private intdogNumber;1Dog(int i) dogNumber=i;子PrePage 7
Prepared by David Page 7 编码通则 ——空行 class Cat { private int catNumber; Cat(int i) { catNumber = i; } public int getNumber() { int tmpNumber; if (catNumber > 0) { tmpNumber = catNumber; } System.out.println("."); } } class Dog implements Comparable { private int dogNumber; Dog(int i) { dogNumber = i; } } class Cat { private int catNumber; Cat(int i) { catNumber = i; } public int getNumber() { int tmpNumber; if (catNumber > 0) { tmpNumber = catNumber; } System.out.println("."); } } class Dog implements Comparable { private int dogNumber; Dog(int i) { dogNumber = i; } }
编码通则一一空格下列情况下使用空格隔开：·关键词和其后的括号之间；·用逗号分隔的参数列表中，逗号后加空格；·所有的二元操作符与其操作数之间用空格分开：·for语句的表达式之间用空格分开；·强制类型转换应该用空格分开下列情况下不使用空格隔开·一元操作符与操作数不加空格：·函数名和括号之间不加空格Prepared byDavidPage 8
Prepared by David Page 8 编码通则 —— 空格 下列情况下使用空格隔开： • 关键词和其后的括号之间； • 用逗号分隔的参数列表中，逗号后加空格； • 所有的二元操作符与其操作数之间用空格分开； • for语句的表达式之间用空格分开； • 强制类型转换应该用空格分开。 下列情况下不使用空格隔开： • 一元操作符与操作数不加空格； • 函数名和括号之间不加空格
—一空格编码通则while(true){while (true) (void method(int i, int j)iintj)(void method(int i17a-+;a+=5;for(expr1;expr2;expr3)for(expr1;expr2;expr3)myFunc((int)num,(Object)o);myFunc(int) num, (Object)p);a++;Prepared byDavidPage 9
Prepared by David Page 9 编码通则 —— 空格 while (true) { . } void method(int i, int j) { . } a += 5; for (expr1; expr2; expr3) myFunc((int) num, (Object) o); a++; while(true) { . } void method(int i,int j) { . } a+=5; for (expr1;expr2;expr3) myFunc((int)num, (Object)o);
编码通则一一语句一行代码只做一件事，即一行代码只写一个语句或定义一个变量，int numA;intnumA,numB:int numB;numA=numB=5;numB=5;numA=5;numB=6;numA=numB;Prepared by DavidPage 10
Prepared by David Page 10 编码通则 —— 语句 int numA; int numB; numB = 5; numA = numB; int numA, numB; numA = numB = 5; numA=5; numB=6; 一行代码只做一件事，即一行代码只写一个语句或定 义一个变量