代码规范_.doc

源程序代码规范

I.总则

1.1 目的
为了对程序员的开发进行适当的规范化，特制定本规范。其根本目的，是为了保证程序具有良好的、一致的结构，以期提高程序的可读性及可维护性，方便程序的测试、维护、升级等工作，同时，也培养程序员书写代码的规范性。

1.2原则
名称反映含义,形式反映结构；

1.3 申明
本规范适用于采用DELPHI作开发工具的公司所有项目，程序员应严格按照本规范编写代码，如项目有确实需要的特殊要求，也必须经项目经理审核后，把该特殊要求形成文档当作本文档的随附文件一起保存。

1.4文档编写：薛国顺2001年6月23日
第一次修改：薛国顺2001年7月7日
第二次修改：薛国顺2001年9月28日

II.代码规范

2.1项目规范

2.1.1．每一个项目的代码、文档按模块、功能必须在项目文件夹中有条理的归类存放，每个项目文件夹中均必须包含以下子文件夹：
Code：源代码目录
Sql：数据库脚本目录
Demodata：演示数据目录
Userdata：用户数据目录
Help：帮助文档目录
Install：安装文件目录
Document：文档目录
Picture：图片目录
templates：报表模板目录
子文件夹下也必须依照详细的用途分类建立子目录。详细的示例如下：

示例：

ProjectName
|
codesqldemodataPicturehelpinstalldocumenttemplates
||
appserverclient|
|测试文档设计文档数据字典需求分析用户文档
module1module2module3……

2.1.2．每个项目的主目录下均必须有一个项目说明文件，说明该项目的一些概要性提示和相关规范。

2.1.3．在项目文件夹下的每层每个子目录中必须有一个文件夹说明文件，说明该层文件夹及其子文件夹的分类方法和含义。任何时候，新增一个文件夹时，均必须在同层目录下的文件夹说明文件中添加所新增文件夹的分类含义，同时创建该文件夹下的文件夹说明文件。

2.1.4．工程文件代码规范：
A．任何一个工程文件（包括动态链接库工程文件）的第一部分必须用注释的形式说明项目名称、公司版权、工程描述、版本说明、创建日期、作者以及后续更新人员。
B．除主模块、公共函数模块和公共数据模块外，所有该项目下的单元不可由项目自动创建（CREATE），在加入新单元后，必须在工程文件中删除自动CREATE的语句。
C．工程文件的其余代码遵行本文档约定的单元规范及其它代码规范；

2.2单元总体规范

2.2.1每个单元的第一部分必须用注释的形式说明项目名称、公司版权；

2.2.2必须紧接在单元名之后以注释的形式说明项目名称、模块名称、模块描述、模块版本、创建日期、作者、更新人以及TODO列表；

2.2.3在INTERFACE部分USE的单元原则上只允许DELPHI的IDE自动添加，如确需自己添加必须在引用到的单元名后用{}注释添加原因。用于编译开关控制的伪指令插入在USE之前。

2.2.4Interface部分应当只包含需要被外部单元访问的类型、变量、过程和函数的声明，而且这些声明应当在Implementation部分之前。

2.2.5Implementation部分包含本单元私有的类型、变量、过程和函数的声明。

2.2.6除非确实需要，不要在Initialization部分写过多代码，如有代码应详细注释说明必须写在Initialization部分的原因。

2.2.7在Finalization部分释放所有在Initialization部分中分配的资源。

2.2.8除主FORM外，每个FORM单元都应当含有实例化函数（入口函数），用于创建、设置、显示和释放FORM。FORM的变量应当从单元中移走，改在实例化函数中作为局部变量定义（要先从ProjectOptions对话框的自动生成列表中移走该FORM）。（参见2.1.4.B）

2.2.9总体风格
缩进规则：每级间保持两个空格。不要将"Tab"符号存储到源文件中，原因是"Tab"字符在不同的源代码管理中宽度会有不同的定义。在Tools|EditorOptions的General页不要选中SetTabCharacter和OptimalFill复选框，制表符"Tab"即不会被保存。
边距页宽：边距应保持默认设置的80个字符，只要可能，长度超过一行的语句必须用逗号或运算符换行。换行后，应缩进两个字符。
注释规则：只有在一行的行末注释时才用//，否则均必须使用{}来注释。
空行使用：需使用空行的地方有：版权块、类之间、方法过程函数之间、方法内部算法