软件开发项目开发规范.doc

JAVA语言编程格式规范
软件研发中心XX项目组
2013．03

目录
1. 前言 4
2. 试用范围 4
_VALUE
变量和参数
采用 直接定义的方法，要做到清晰易懂的原则，如：
实体类 例如：Project project;直接把类型的首个大写字母变成小写字母就行了。
日期型 例如：Date createDate;
组件/部件
应采用完整的英文描述符命名组件（接口部件），遵循匈牙利命名法则
如：btnOK，lblName。
按钮变量  btn+Xxxxxxx    例如：btnSave,btnExit,btnPrint等
题标变量  lbl+Xxxxxxxx    例如：lblName,lblSex等
对象类型    前缀
Canvas    cvs
CheckBox    chk
Image     img
List     list
Choice    chc
Dialog    dlg
Event    evt
Frame    frm
Menu    menu
Panel    pnl
TextArea   txa
TextField   txf
集合
采用变量+集合类型的方法一个集合定义，如果集合采用泛型的话就必须泛型化处理如：
Array userArray = new Array(); //用户列表
Map userMap = new Map();//用户Map
List<User> onLineUserList = new List< User >();//在线用户List
神秘的数
程序里经常会用到一些量，它是有特定的含义的，把神秘的数定义为一个常量。注意这个常量的命名应该能表达该数的意义，并且应该全部大写，以与对应于变量的标识符区别开来。例如50这个数，可以定义为一个名为NUM_OF_EMPLOYEES的常量来代替。
其他
命名时应使用复数来表示它们代表多值。如：orderItems。
Java异常
异常类名由表示该异常类型的单词和Exception组成，如ActionException。
异常实例一般使用e、ex等，在多个异常时使用该异常名或简写加E，Ex等组成，如：
SQLEx;ActionEx
数组命名
数组应该总是用下面的方式来命名：
byte[] buffer;
而不是
byte buffer[];
书写格式规范
严格要求书写格式是为了使程序整齐美观、易于阅读、风格统一，程序员对规范书写的必要性要有明确认识。建议源程序使用eclipse工具开发，格式规范预先在工具中设置。
缩进
缩进建议以4个空格为单位。预处理语句、全局数据、标题、附加说明、函数说明、标号等均顶格书写。语句块的"{"、"}"配对对齐，并与其前一行对齐，语句块类的语句缩进建议每个"{"、"}"单独占一行，便于匹对。Mysclipse 中的默认方式是开始的"{"不是单独一行，建议更改成上述格式。
空格
原则上变量、类、常量数据和函数在其类型，修饰名称之间适当空格并据情况对齐。关键字原则上空一格，如：if ( ... ) 等。运算符的空格规定如下："::"、"->"、"["、"]"、"++"、"--"、"~"、"!"、"+"、"-"（指正负号）、"&"（引用）等几个运算符两边不加空格（其中单目运算符系指与操作数相连的一边），其它运算符（包括大多数二目运算符和三目运算符"?:"两边均加一空格，在作函数定义时还可据情况多空或不空格来对齐，但在函数实现时可以不用。","运算符只在其后空一格，需对齐时也可不空或多空格。不论是否有括号，对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。个人认为此项可以依照个人习惯决定遵循与否。
对齐
原则上关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。另每一行的长度不应超过屏幕太多，必要时适当换行，换行时尽可能在","处或运算符处，换行后最好以运算符打头，并且以下各行均以该语句首行缩进，但该语句仍以首行的缩进为准，即如其下一行为“{”应与首行对齐。
变量定义最好通过添加空格或TAB键形成对齐，同一类型的变量最好放在一起。如下例所示：
int        nValue;
int        nResult;
int        nLength;
空行
不得存在无规则的空行，比如说连续十个空行。程序文件结构各部分之间空一行，由于每个函数还要有函数说明注释，故通常只需空一行或不空，但对于没有函数说明的情况至少应再空一行。对自己写的函数，