程序书写规范

3
System FrameWork Package
4
System Package
Ex
正确：
import java.io.*;
import java.rmi.*;
import java.util.*;//上面是java标准包
import javax.ejb.*;
import javax.naming.*;
Ex:
正确：
String applicationName;public void validateUser(int userId, String password)
错误：
String applicationname;public void validateUser(int UserId, String s)
case 4:
func4();
break;
case 3:
func3();
//not break;
case 2:
func2();
break;
case 1:
func1();
break;
}
错误：缺少缩进以及“not break”
switch (funcNo) {
case 4:
func4();
break;
case 3:
Ex:
正确：
SomethingHandler.java; SomethingProxy.java, SomethingDAO.java
错误：
somethinghandler.java; somethingProxy.java, Somethingdao.java
●Java方法的命名
方法的命名要体现出此方法的作用。
}
错误：
if(cnt == 1){
fileName = "file1.txt";
}else{
fileName = "file2.txt";
}
4.2.
for循环、while循环、do while循环，和if语句一样，“for”“while”和“（”以及“）”和“｛”之间要有一个半角空格。另外在for语句的条件括号中，“；”、“＝”还有逻辑运算符（如“>”、“<”）的两侧必须要有空格。While语句的括号中也是同理。
//重新获取返回值
returnValue = "this is the second String";
//add by xiaoqiao at 2003-03-06 end
/*############# by xiaoqiao at2003-4-4start
对于原作者的内容根据新的修改需要所注释掉的部分
●修改的内容中随时写注释。
Ex：注意用红字标识出的部分。
/**
* <p>Title: TestDoc</p>
* <p>Description: this is a test for javadoc</p>
* <p>Copyright: Copyright (c) 2003 </p>
* <p>Company:首都信息发展股份有限公司</p>
*/
return returnValue;
}
}
4.
4.1.
●if语句不允许使用省略方式，即必须带有{}。哪怕if块中只有一句代码。
Ex
正确：
if (cnt == 1) {
fileName = "file1.txt";
} else {
fileName = "file2.txt";
}
错误：
if (cnt == 1)
func3();
case 2:
func2();
break;
case 1:
func1();
break;
}
5.
5.1.
在程序中如果import了多个包的话，请遵照这样的import顺序。并且，对于同一级的包，应该按照字母顺序进行排序。
No
Package
1
Java Package
2
Javax Package
}
while(count>0){
…
}
do{
…
}while()
4.3.
●通常，switch语句中各个case之后，都会有break结束。如果下一个case还要接着执行，一般在break的位置添加一个注释行“//not break;”。
●switch和case语句均需要缩进。
Ex
正确：请注意空格与缩进
switch (funcNo) {
注释应被用来给出代码的概括，并提供代码自身没有提供的附加信息。注释应该仅包含与阅读和理解程序有关的信息。
在注释里，对设计决策中重要的或者不是显而易见的地方进行说明是可以的，但应避免提供代码中己清晰表达出来的重复信息。多余的的注释很容易过时。通常应避免那些代码更新就可能过时的注释。
3.2.
3.2.1.
●Java常量的命名
这里常量指的是类型为static final的变量。常量全部以大写字母书写，如超过一个单词，则应采用“_”链接，单词可使用缩写。如：PI、HOUSE_TYPE
Ex:
正确：
static final String SYSTEM_ADMIN_USER =“admin”;
错误：
static final String SYSTEMADMINUSER =“admin”;
软件的最终发布性文件，包括最终的可执行程序、动态链接库、帮助文件等文件的命名，由项目负责人统一确定。
软件的最终使用性名称，包括整个软件的名称及单个模块的名称，包括安装后的菜单项及快捷方式的名称，由项目负责人统一确定。整个软件的大名称由公司经理确认。
2.2.
2.2.1.
●Java包的命名
包名的所有单词均为小写。
●Java文件名的命名
文件名必须与类名相同，遵守和类名相同的规则。
●Java数组的命名
数组的方括号应该在变量前面，而不是后面。
Ex:
正确：
byte[] buffer;
错误：
byte buffer[];
3.
3.1.
Java程序有两类注释：实现注释(implementation comments)和文档注释(document comments)。实现注释是那些使用/*...*/和//界定的注释。文档注释(被称为"doc comments")是Java独有的，并由/**...*/界定。文档注释可以通过javadoc工具转换成HTML文件。
/*变量的说明*/或者//变量的说明
如果注释在多行内，采用这样的注释
/*
*变量的说明
*…
*/
3.2.5.
这里指的修改主要对应于这样的情况：
●自己在修改别人的代码时，需要注释
●虽然是自己的代码，但出现了大的业务改动，需要注释
修改方法：
●在类注释的author一栏中加入修改人、修改时间和修改原因。
●在代码中将自己修改的部分用注释区分出来，注释中需要有修改人，修改时间，修改开始和解释描述。
程序书写过程中，牢记有关要求，不怕麻烦。
1.1.2.
以下给出程序书写有关规范：
程序必须使用逐层缩进的格式；
程序中必须有注释(有关注释使用规范在随后章节中单独说明)；
建议分行书写复杂表达式和复杂语句；
方法中的程序段不宜过长；
除在极为特殊的情况下，禁止使用系统或其它软件开发包提供的未公开的函数调用。
1.2.
方法名的第一个单词的打头字母要小写，其后单词打头字母为大写。如：drawPicture( )、getHouse( )。
Ex:
正确：
public void changePassword()
错误：
public void changepasswHale Waihona Puke rd()●Java变量的命名
变量名的第一个单词的打头字母要小写，其后单词打头字母为大写。变量的命名应该体现该变量代表的含义。该规则既适用于类的属性，也适用于方法中的变量和方法使用的参数。
1.
1.1.
1.1.1.
良好的程序书写风格将有助于提高软件的质量和效率。
程序书写风格在以下方面体现：常量、变量的使用；注释的使用；变量、属性及方法的命名；语句的书写与使用地点。
以下建议将有助于培养良好的程序书写风格：
多阅读他人程序，包括阅读厂商提供的源程序，学习优点；
从程序错误中吸取教训，不再犯同样错误；
* @exception SQLException SQL语句错误
*/
public boolean isUserExist(int userId)
throws LogicException, SQLException {
...
}
3.2.3.
属性的注释分为2种：
●需要生成javadoc的变量注释（即文档注释）
*
* @author xiaoqiao 2003-03-05 create<br />
* liqiang 2003-05-05 modify for test<br />
* @version 1.0
*/
public class TestDoc {
public String testDoc(String s1, int i2) throws Exception {
String returnValue = getReturnString();