編寫目的
本規範定義為程式在編寫過程中所涉及的程式文件和編碼風格。本規範以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
單元頭定義，加入到每個單元的前面。
{************************************************* ****
單元名稱：
功能描述：
作者：
軟體名稱：
版本：
公司名稱：刀劍如夢軟體創作室
************************************************** *** }
軟體版本號格式定義：
軟體中採用如下的版本號格式：XXXX
例如：可發布的程式完成後將版本號標為”1.0.0.0”
第一位：版本號。註：軟體又重大的改進後所形成的版本。
第二位：維護號。註：已有的版本的基礎上修改了某些錯誤形成的版本。
第三位：補丁號。註：當程式修改某些錯誤，未形成新的維護號碼時，用補丁號。
第四位：修正號。註：當出現緊急程序錯誤時，修改後程序用作標識，不作為發布程序的版本號。 yckxzjj