打印本文 打印本文 关闭窗口 关闭窗口
Delphi的编码规范
作者:武汉SEO闵涛  文章来源:敏韬网  点击数1414  更新时间:2009/4/23 18:31:05  文章录入:mintao  责任编辑:mintao

1.规范简介

本规范主要规定Delphi源程序在书写过程中所应遵循的规则及注意事项。编写该规范的目的是使公司软件开发人员的源代码书写习惯保持一致。这样做可以使每一个组员都可以理解其它组员的代码,以便于源代码的二次开发记忆系统的维护。

 

2.单元的格式

2.1 基本要求

2.1.1 缩进

     缩进就是在当源程序的级改变时为增加可读性而露出的两个空格。缩进的规则为每一级缩进两个空格。不准许使用Tab。因为Tab会因为用户所作的设置不同而产生不同的效果。当遇到begin 或进入判断、循环、异常处理、with语句、记录类型声明、类声明等的时侯增加一级, 当遇到end或退出判断、循环、异常处理、with语句、记录类型声明、类声明等的时侯减少一级。

2.1.2  Begin…End

           begin语句和end语句在源程序中要独占一行,例如:
for I := 0 to 10 do begin //不正确的用法
end;
for I := 0 to 10 do //正确的用法
begin
end;

2.1.3空格

在操作符及逻辑判断符号的两端添加空格,例如:I  :=  I + 1;,a  and b 等,

但添加括号时不需要空格。

例如:if ( a>b )and( a错误的用法
  if (a  >  b)  and  (a  <  c) then //正确的用法

2.1.4 变量

         尽量不用缩写,尽量用名词,如有多个单词则每个单词的第一个字符一定要大写;见名知意

   所有模块内全局变量必须用‘F’为前缀。如果几个模块之间需要进行资料交换,则需要通过声明属性的方法来实现。

2.2单元说明

  新建每一个新单元文件时,请先按如下格式定制单元说明

{*******************************************************
Copyright?(c)?2000-2004?*********公司技术开发部

Project:---该单元所属的项目

Module:---该单元所属的功能模块

Describe:---该单元的功能

Author:---创建人

Date:---创建日期

Version版本号:

History`s Modification:---修改历史区域

{*************************

                              Modify No:---修改编号

                        Modifier:---修改人
                        DateTime:---修改时间
                        Cause:---修改原因

                        Modify No:---修改编号

                        Modifier:---修改人
                        DateTime:---修改时间
                        Cause:---修改原因

                       *************************}

*******************************************************}

 2.3 过程与函数的说明

 {*******************************************************

  PrcedureeName/FunctionName:
Input: a---输入参数说明,b---输入参数说明,c---输入参数说明
Output: x---输出参数说明

Const: s---常量说明,t---常量说明

var: x---变量说明, j---变量说明

Describe:----功能描述

若该过程或函数不是该单元创建人所撰写请在此后再加上以下几项内容:

     Author:

     Date:

*******************************************************}

3.控件的命名

控件的名称可使用以下简写,但所用简写于控件名称之间药添加‘_’:

Standard Tab
mm    TMainMenu
pm    TPopupMenu
mmi   TMainMenuItem
pmi   TPopupMenuItem
lbl     TLabel
edt    TEdit ; TSpinEdit ; TMaskEdit
mem  TMemo
btn    TButton ; TBitBtn ; TSpeedButton ; TSpinButton
cb      TCheckBox
rb      TRadioButton
lb       TListBox
cb     TComboBox
scb   TScrollBar
gb    TGroupBox
rg     TRadioGroup
pnl   TPanel
cl     TCommandList


Additional Tab

sg      TStringGrid
dg      TDrawGrid
img    TImage
shp    TShape
bvl     TBevel
sbx     TScrollBox
clb      TCheckListbox
spl      TSplitter
stx      TStaticText
cht     TChart


Win32 Tab
tbc     TTabControl
pgc    TPageControl
il        TImageList
re       TRichEdit
tbr     TTrackBar
prb    TProgressBar
ud   &

[1] [2]  下一页

打印本文 打印本文 关闭窗口 关闭窗口