1,規范簡介
本規范主要規定Delphi源程序在書寫過程中所應遵循的規則及注意事項。編寫該規范的目的是使公司軟件開發人員的源代碼書寫習慣保持一致。這樣做可以使每一個組員都可以理解其它組員的代碼,以便於源代碼的二次開發記憶系統的維護。
2,一般格式規范
2.1 縮進
縮進就是在當源程序的級改變時為增加可讀性而露出的兩個空格。縮進的規則為每一級縮進兩個空格。不准許使用Tab。因為Tab會因為用戶所作的設置不同而產生不同的效果。當遇到begin 或進入判斷、循環、異常處理、with語句、記錄類型聲明、類聲明等的時侯增加一級, 當遇到end或退出判斷、循環、異常處理、with語句、記錄類型聲明、類聲明等的時侯減少一級。例如:
if TmpInt <> 100 then
TmpInt := 100;
2.2 Begin..End
begin語句和end語句在源程序中要獨占一行,例如:
for I := 0 to 10 do begin //不正確的用法
end;
for I := 0 to 10 do //正確的用法
begin
end;
2.3 空格
在操作符及邏輯判斷符號的兩端添加空格,例如:I := I + 1;,a and b 等,但添加括號時不需要空格。例如:if ( a > b ) then //錯誤的用法
If (a > b) then //正確的用法
又例如:procedure Test(Param1: integer; Param3: string);
3. Object Pascal 語法書寫格式規范
3.1 保留字
Object Pascal 語言的保留字或關鍵詞應全部使用小寫字母。
3.2 過程和函數
3.2.1命名及格式
過程和函數的名稱應全部使用有意義的單詞組成,並且所有單詞的第一個字母應該使用大寫字母。例如:
procedure formatharddisk;//不正確的命名
procedure FormatHardDisk;//正確的命名
設置變量內容的過程和函數,應使用Set作為前綴,例如: procedure SetUserName;
讀取變量內容的過程和函數,應使用Get作為前綴,例如:function GetUserName: string;
3.2.2 過程和函數的參數
3.2.2.1命名
統一類型的參數寫在同一句中: procedure Foo(Param1, Param2, Param3: Integer; Param4: string);
3.2.2.2命名
所有參數必須是有意義的;並且當參數名稱和其它屬性名稱重了的時候,加一個前綴‘A’, 例如:
procedure SomeProc(AUserName: string; AUserAge: integer);
3.2.2.3命名沖突
當使用的兩個unit中包括一個重名的函數或過程時, 那幺當你引用這一函數或過程時,將執行在use 子句中後聲明的那個unit中的函數或過程。為了避免這種‘uses-clause-dependent’需要在引用函數或過程時,寫完整函數或過程的出處。例如:
SysUtils.FindClose(SR);
Windows.FindClose(Handle);