电力营销PDA系统编码规范.doc

XX电网公司营销PDA系统
编码规范

2009年11月02日
目录
4
4
4
4
package 的命名 4
class 的命名 4
class 变量的命名 4
static final 变量的命名 5
参数的命名 5
数组的命名 5
方法的参数 5
5
7
java文件样式 8
++编码规范 11
11
16
19
19
19
19
表空间 19
表空间文件 20
表 20
属性(列或字段) 20
主键 21
外键 21
CHECK约束 21
UNIQUE约束 21
索引 21
触发器 21
簇 22
视图 22
序列 22
同义词 22
存储对象相关 22
存储流程 22
函数 22
包 23
函数文本中的变量采用下列格式命名: 23
用户及角色 23
数据库链接 23
命名中的其它留心事项 23
24
一般性注释 24
函数文本注释 24
常用SQL 语句的编写规范 25
条件执行语句(IF)编写规范 27
循环语句编写规范 28
函数文本(存储流程、函数和包等) 28
29
29
29

一个软件的生命周期中,80%的花费在于维护,几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护,编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码,如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误。同一项目参与编程的人可能有各自编程的经验和习惯,不同风格的程序代码使维护工作变得复杂和困难。为了提高代码的可读性、系统的稳定性及降低维护和升级的成本,特编写本规范以统一各开发人员的编程工作。

本规范适用XX电网公司移动PDA项目组。


定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。命名一般以简介单词构成。
package 的命名
package 的名字应该都是由一个小写单词组成。
.
class 的命名
class 的名字必须由大写字母开头而其他字母都小写的单词组成,对于所有标识符,其中包含的所有单词都应紧靠在一起,而且大写中间单词的首字母。
public class ThisAClassName{}
class 变量的命名
变量的名字必须用一个小写字母开头。后面的单词用大写字母开头
userName , thisAClassMethod
static final 变量的命名
static final 变量的名字应该都大写,并且指出完整含义。
public static final String
DB_CONFIG_FILE_PATH ="";
参数的命名
参数的名字必须和变量的命名规范一致。
数组的命名
数组应该总是用下面的方式来命名:
byte[] buffer;
而不是: byte buffer[];
方法的参数
使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字:
setCounter(int size){
= size;
}

Java的注释有三种
// 注释一行
/* ...... */ 注释若干行
/** ...... */ 注释若干行,并写入javadoc文档,也叫java文档注释
注释要简单明了。
String userName = null; //用户名
边写代码边