Arch4系统开发指南-开发规范篇 中科软科技股份有限公司
List dataList = new ArrayList (); dataList.addItem (str);
正确的方法:
List dataList = new ArrayList (); dataList.add (str); 7.5 避免把方法本地变量和参数定义成和类变量相同的名字
把任何的变量都定义成唯一的,避免引起混淆。 错误的方法:
public void method (int j) { final int i = 5; // VIOLATION } private int j = 2; 正确的方法:
public void method (int j1) { final int i = 5; // VIOLATION } private int j = 2; 7.6 为所有序列化的类创建serialVersionUID
为所有序列化的类创建一个serialVersionUID,可以避免破坏序列的兼容性。如果不特别制订一个UID的话,系统会自动计算UID(根据类的内容)。如果类被改变了,即时它是兼容的,你也不能反序列化老的版本了。在类中加如一个UID,编码控制类的兼容性。 错误的方法:
public class DUID implements java.io.Serializable { public void method () {} } 正确的方法:
public class DUIDFixed implements java.io.Serializable { private static final long serialVersionUID = 1L; public void method () {} } 7.7 常量的定义加上final关键字
常量的定义应该加上final标记,保证常量值从自始至终都不会改变。 错误的方法:
private int SIZE = 5; 正确的方法:
第 16 页 共 20 页
Arch4系统开发指南-开发规范篇 中科软科技股份有限公司
private final int SIZE = 5; 7.8 数组的声明习惯
数组应该总是用Java的方式来声明,及中括号放在类型后面。 错误的方法:
byte buffer[]; 正确的方法:
byte[] buffer; 7.9 一行只写一条语句
一行里只写一条语句,不要挑战人的习惯用法。 错误的方法:
public class OSPL { int method (int a, int b) { int i = a + b; return i; // 可读性不强 }
正确的方法:
public class OSPLFixed { int method (int a, int b) { int i = a + b; return i; } } 7.10 正确释放JDBC连接
如果有JDBC连接没有关掉的话,需要在\方法中关掉 。如果数据库连接失败或者是没有释放连接,看上去无关紧要。但是其他的用户就需要用更长的时间等待连接,这样数据库利用效率就会下降。确保你的代码在任何情况下,包括出错或者程序异常终止的情况下都释放数据库连接。在\方法中关掉连接,就可以确保这一点。 错误的方法:
try { Statement stmt = con.createStatement(); } catch(SQLException e) { e.printStackTrace(); } 正确的方法:
try { Statement stmt = con.createStatement(); } finally { 第 17 页 共 20 页
Arch4系统开发指南-开发规范篇 中科软科技股份有限公司
} if (con != null && !con.isClosed()) { con.close(); } 7.11 表示长整数时用L来代替l(小写L)
表示长整数时用L来代替l(小写L),因为l(小写L)很难和1(数字1)区分。 错误的方法:
long temp = 23434l; 正确的方法:
long temp = 23434L; 7.12 Java注释
单行注释以前缀//开头,样例如下所示: // Java中的单行注释 多行注释以/*开头,以*/结尾,样例如下所示: /* Java中的多行注释 不能嵌套使用 */
JavaDoc注释以/**开头,以*/结尾,可以工具生成JavaDoc文档。样例如下所示: /** JavaDoc注释 能多行 不能嵌套使用 可用工具生成JavaDoc文档 */ 第 18 页 共 20 页
Arch4系统开发指南-开发规范篇 中科软科技股份有限公司
8 JavaScript开发规范
8.1 JavaScript原则
所有的JavaScript脚本都应该是标准的,要求支持IE6+、Safari、FileForx3.6+, Google Chrome等主流
浏览器。
8.2 命名规范
3. JavaScript文件
JavaScript 程序应独立保存在后缀名为.js的文件中。
JavaScript 代码不应该被包含在 HTML 文件中,除非这是段特定只属于此部分的代码。在 HTML 中的JavaScript代码会明显增加文件大小,而且也不能对其进行缓存和压缩。
filename.js 应尽量放到 body 的后面。这样可以减少因为载入脚本而造成其他页面内容载入也被延迟的问题。
4. 变量名命名规范
* 常量及全局变量采用全部大写的形式。
* 变量名采用大小写混合形式,除首单词的字母全部小写外其余单词的首字母都大写。
* 变量名过长的可以采用单词缩写,除广泛使用的缩写外,采用单词缩写的变量名必须添加注释。 5. 变量使用规范
* 变量名使用之前必须定义,未定义的变量名禁止使用。 * 变量的使用要尽量的减小作用域。例如: for(var I = 0;I * 函数名尽量采用 “动词+名词”的命名方式。 * 函数名称中的动词前缀必须是和函数功能相关的完整动词。 * 函数名称的第一个单词全部小写,后面的单词首字母大写。例如: function getUserName(){ .........//此处要开始缩进。 } 7. 缩进 第 19 页 共 20 页 Arch4系统开发指南-开发规范篇 中科软科技股份有限公司 缩进的单位为两个空格。避免使用 Tab 键来缩进。因为始终没有个统一的 Tab 长短标准。 虽然使用空格会增加文件的大小,但在局域网中几乎可以忽略,且在最小化过程中也可被消除掉。 8. 函数声明 所有的函数在使用前进行声明。 内函数的声明跟在var语句的后面。这样可以帮助判断哪些变量是在函数范围内的。函数名与“(”(左括号)之间不应该有空格。“)”(右括号)与开始程序体的“{”(左大括号)之间应插入一个空格。函数程序体应缩进四个空格。“}”(右大括号)与声明函数的那一行代码头部对齐。 function outer(c,d) { var e = c * d; function inner(a, b) { return (e * a) + b; } return inner(0, 1); } 8.3 JavaScript注释 1.单行注释 插入单行注释的符号是“//”,示例如下所示: 2.多行注释 多行注释以\/*\开始,以\*/\结束,示例如下所示: 第 20 页 共 20 页