xx软件公司产品开发代码规范-2-5

xx软件公司产品开发代码规范

2、工程文件代码规范

a．任何一个工程文件（包括动态链接库工程文件）的第一部分必须用注释的形式说明项目名称、公司版权、工程描述、版本说明、创建日期、作者以及后续更新人员。

b．除主模块、公共函数模块和公共数据模块外，所有该项目下的单元不可由项目自动创建（CREATE），在加入新单元后，必须在工程文件中删除自动CREATE的语句。

c．工程文件的其余代码遵行本文档约定的单元规范及其它代码规范；

3、单元总体规范

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

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

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

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

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

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

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

4、总体风格

缩进规则：

每级间保持两个空格。不要将"Tab"符号存储到源文件中，原因是"Tab"字符在不同的源代码管理中宽度会有不同的定义。在Tools | Editor Options 的General 页不要选中 Set Tab Character和Optimal Fill复选框，制表符"Tab"即不会被保存。

边距页宽：

边距应保持默认设置的80个字符，只要可能，长度超过一行的语句必须用逗号或运算符换行。换行后，应缩进两个字符。

注释规则：

注释应在行末或只有在一行的行末注释时才用//，整段注释用{}

空行使用：

需使用空行的地方有：版权块、类之间、方法过程函数之间、方法内部算法分段。

Begin…End：

任何情况下，Begin和End均必须各自独占一行。End总和对应的Begin左对齐。

工具使用：

所有单元提交给版本控制工具之前必须用Source Code Formatter格式化过。

5、常量区规范

A、所有常量的第一个前缀必须为CONST_，常量必须分主题归类定义，如有多个主题，每一个主题必须加一个主题前缀。前缀与前缀之间、前缀与名称之间用_分割。

B、每个常量的定义单独一行，在同一行上，必须用//加注释说明该常量的含义。

C、按主题归类的常量，在每个主题开始的第一行必须用{}注释主题含义。

D、示例：

Const

{ 主题1 }

CONST_主题前缀1_--- = ----； // 含义

CONST_主题前缀1_--- = ----； // 含义

{ 主题2 }

CONST _主题前缀2_--- = ----； // 含义

CONST _主题前缀2_--- = ----； // 含义