Delphi编程规范1.0.0.0

[入库:2005年8月18日] [更新:2007年3月24日]

本文简介:选择自 yckxzjj 的 blog

编写目的
本规范定义为程序在编写过程中涉及到的程序文件和编码风格。本规范以 delphi 语言为标准制定.

项目文件的组织
在delphi中,按照项目为单位来组织程序文件。在一个典型的项目中包括:
项目文件(.drp文件)
含有工程主程序的pascal源代码;
单元文件(.pas文件)
项目中每个窗体的pascal源文件,包含该窗体的所有声明和过程(包括时间处理过程);
窗体文件(.dfm文件)
含有一个窗体的设计属性的二进制文件,每个窗体的.dfm文件与.pas文件相互对应;
资源文件(.res文件)
编译的二进制资源文件,被链接到应用程序的可执行文件中;
项目选项文件(.dof文件)
存储了project|options菜单命令所设置的项目选项;
桌面设置文件(.dsk文件)
存储了tools|options菜单命令所设置的桌面选项;
包文件(.dpk/.bpl文件)
用于共享组件、类、数据和代码的文件。源文件为.dpk文件,编译后为.bpl文件;

常量定义
内容:
逻辑值的定义;
常数值的定义;
错误码的定义;

格式:一个定义占一行。如下:
const <常量> : 类型 = 值;  //注释
 说明:
        使用 const 语句来声明用于代替文字值的常数。

示例:const c_sql:string='select ch_userer_id from t_cd_user'; //查询用户id
const c_pi:real =3.1415926;   //圆周率
结构类型定义
内容:结构类型定义
格式:
type 
<类型名>       //结构说明注释
    <变量名1> : 变量类型;       //变量说明注释
    <变量名2> : 变量类型;       //变量说明注释

end ;

说明:
<类型名>是以大写字母开头的字符串。结构定义中定义变量类型的语句从第二行第五列开始。

示例:
type
tablelist=record   //系统树单元类型定义
  inid: integer;      //单元编号
  name: string;     //单元名称
  pid: string;      //上一级单元名称
  pt: ptablelist;   //指向下一单元类型的指针
  end;

程序风格

程序风格规定了每个语句的定位规则及程序中的注释。
函数(function)/过程(procedure)风格
<function/procedure> name (变量: 变量类型[,…]);//函数/过程说明
var
  变量1:变量类型;//变量说明
  变量2:变量类型;//变量说明
  …
begin
  语句;
  语句;
  ……
end ;
注: 变量声明、语句均从第三列写起,如有缩进,每次缩进两列,并与相对应语句对齐。

语句风格
说明:
在程序体中通常最多每十行有一个段落功能说明;
规范使用各种语句;
语句中有缩进是以二列为单位。

变量定义语句
var 
var_name : <数据类型>;

赋值语句
var_name: = <表达式>;

条件语句
if 条件 then    //注释
begin
  语句;
  …
end    
else if 条件 then   //注释
  begin
    语句;
    ...
  end
else       //注释
  语句;
注:如果执行语句只有一句,可省略begin、end语句。
循环语句
//循环功能注释
for counter := start to end do
begin
  [语句];
  …
end;

//循环功能注释

while [condition] do
begin
  [语句];
  …
end;

//循环功能注释
repeat
  [语句];
  …
until [condition]

开关语句
//开关功能说明
case <表达示> of
  <值1>:[语句1];
  <值2>:[语句2];
  …
  <值n>: [语句n]
end;

注释行
在程序代码单元文件顶端必须拥有本单元文件“模块说明”及“单元说明”注释。
对于常量、结构类型、函数/过程、自定义变量、代码段功能块、关键语句等有含义的代码部

分,必须有注释行进行详细说明。
注释行可在需说明部分行后以“//xxxxxxxx”方式添加,也可在需说明部分行上

以“{xxxxxxxx}”方式添加多行或以“//xxxxxxxx”方式添加一行。

文件及窗体命名
  含义            类名               命名格式
工程文件       program(.dpr)        xxxxx
  单元          unit(pas)       uxxxxx
  窗体       form.name(.dfm)       xxxxxfrm
数据模块  datamodule       xxxxxdm

单元头定义,添加到每个单元的前面。
{*****************************************************
单元名称:
功能描述:
作者:
软件名称:
版本:
公司名称:刀剑如梦软件创作室
***************************************************** }

软件版本号格式定义:
软件中采用如下的版本号格式:x.x.x.x
例如:可发布的程序完成后将版本号标为”1.0.0.0”
第一位:版本号。注:软件又重大的改进后形成的版本。
第二位:维护号。注:已有的版本的基础上修改了某些错误形成的版本。
第三位:补丁号。注:当程序修改某些错误,未形成新的维护号时,用补丁号。
第四位:修正号。注:当出现紧急程序错误时,修改后程序用作标识,不作为发布程序的版本号。

本文关键:编程规范
  相关方案
Google
 

本站最佳浏览方式为 分辨率 1024x768 IE 6.0(或更高版本的 IE浏览器)

go top