編寫目的
本規范定義為程序在編寫過程中涉及到的程序文件和編碼風格。本規范以 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”
第一位:版本號。注:軟件又重大的改進後形成的版本。
第二位:維護號。注:已有的版本的基礎上修改了某些錯誤形成的版本。
第三位:補丁號。注:當程序修改某些錯誤,未形成新的維護號時,用補丁號。
第四位:修正號。注:當出現緊急程序錯誤時,修改後程序用作標識,不作為發布程序的版本號。