Delphi 程序員代碼編寫標(biāo)準(zhǔn)指南
版權(quán)所有 1998 Xavier Perched和 Steve Teiseira
一、序言
二、通用源代碼格式規(guī)則
2.1 縮格
2.2 頁邊空格
2.3 Begin…End 配對(duì)
三、Object Pascal
3.1 括號(hào)
3.2 保留字和關(guān)鍵字
3.3 過程和函數(shù)（例程）
3.3.1 命名/格式化
3.3.2 形式參數(shù)
3.3.2.1 格式化
3.3.2.2 命名
3.3.2.3 參數(shù)的排序
3.3.2.4 常量參數(shù)
3.3.2.5 名稱的沖突
3.4 變量
3.4.1 變量的命名和格式
3.4.2 局部變量
3.4.3 全局變量的使用
3.5 類型
3.5.1 大寫約定
3.5.1.1 浮點(diǎn)指針類型
3.5.1.2 枚舉類型
3.5.1.3 變數(shù)和ole變數(shù)類型
3.5.2 結(jié)構(gòu)類型
3.5.2.1 數(shù)組類型
3.5.2.2 記錄類型
3.6 語句
3.6.1 if 語句
3.6.2 case 語句
3.6.2.1 一般性話題
3.6.2.2 格式
3.6.3 while 語句
3.6.4 for 語句
3.6.5 repeat 語句
3.6.6 with 語句
3.6.6.1 一般話題
3.6.6.2 格式
3.7 結(jié)構(gòu)異常處理
3.7.1 一般話題
3.7.2 try…finally的使用
3.7.3 try…except的使用
3.7.4 try…except…else的使用
3.8 類類型
3.8.1 命名和格式
3.8.2 域
3.8.2.1 命名/格式
3.8.2.2 可視化
3.8.3 方法
3.8.3.1 命名/格式
3.8.3.2 使用靜態(tài)的方法
3.8.3.3 使用虛擬/動(dòng)態(tài)的方法
3.8.3.4 使用抽象的方法
3.8.3.5 屬性存取方法
3.8.4 屬性
3.8.4.1 命名/格式
3.8.4.2 使用存取的方法
四、文件
4.1 工程文件
4.1.1 命名
4.2 窗體文件
4.2.1 命名
4.3 數(shù)據(jù)模板文件
4.3.1 命名
4.4 遠(yuǎn)端數(shù)據(jù)模板文件
4.4.1 命名
4.5 Unit文件
4.5.1 通用Unit結(jié)構(gòu)
4.5.1.1 unit的名字
4.5.1.2 uses子句
4.5.1.3 interface部分
4.5.1.4 implementation部分
4.5.1.5 initialization部分
4.5.1.6 finalization部分
4.5.2 窗體單元
4.5.2.1 命名
4.5.3 數(shù)據(jù)模板單元
4.5.3.1 命名
4.5.4 一般目的單元
4.5.4.1 命名
4.5.5 構(gòu)件單元
4.5.5.1 命名
4.6 文件頭
五、窗體和數(shù)據(jù)模板
5.1 窗體
5.1.1 窗體類型命名標(biāo)準(zhǔn)
5.1.2 窗體實(shí)例命名標(biāo)準(zhǔn)
5.1.3 自動(dòng)創(chuàng)建窗體
5.1.4 模式窗體實(shí)例化函數(shù)
5.2 數(shù)據(jù)模板
5.2.1 數(shù)據(jù)模板命名標(biāo)準(zhǔn)
5.2.2 數(shù)據(jù)模板實(shí)例命名標(biāo)準(zhǔn)
六、包
6.1 使用運(yùn)行包和設(shè)計(jì)包的比較
6.2 文件命名標(biāo)準(zhǔn)
七、構(gòu)件
7.1 用戶自定義構(gòu)件
7.2 構(gòu)件單元
7.3 使用注冊(cè)單元
7.4 構(gòu)件實(shí)例命名約定
7.5 構(gòu)件的前綴
7.6 Standard頁
7.7 Additional頁
7.8 Win32頁
7.9 System頁
7.10 Internet頁
7.11 Data Access頁
7.12 Data Controls頁
7.13 Decision Cube頁
7.14 QReport頁
7.15 Dialogs頁
7.16 Win3.1頁
7.17 Samples頁
7.18 ActiveX頁
7.19 Midas頁
一、序言
本文檔詳述了在Delphi 4開發(fā)者指南下進(jìn)行編程的代碼編寫標(biāo)準(zhǔn)。在通常情況下，本文檔遵循“取消”式格式的指引方針，該方針由Borland國際通過一些例外來使用。在Delphi 4開發(fā)者指南中包含本文檔的目的在于闡述一種方法，通過該方法，開發(fā)小組可以在他們所編寫的代碼中保持一貫的風(fēng)格。這樣做的目的是使在開發(fā)小組中的每一個(gè)程序員都可以明白其他程序員的代碼。這有助于提高代碼編寫的可讀性和使用的一貫性。
本文檔并不意味著包含了所有存在于代碼中的標(biāo)準(zhǔn)。但是，它的內(nèi)容已足夠幫你起個(gè)好頭。你可以自由的增加修改這些標(biāo)準(zhǔn)來滿足你的需要。我們不贊成你偏離這些由Borland開發(fā)人員所使用的標(biāo)準(zhǔn)太遠(yuǎn)。我們推薦這么做是因?yàn)橐坏┯行碌某绦騿T加入到你的開發(fā)小組中，而他們最喜歡和最熟悉的是Borland的標(biāo)準(zhǔn)。象大多數(shù)代碼標(biāo)準(zhǔn)文檔，本文檔也會(huì)根據(jù)需要進(jìn)行改動(dòng)。因此，你可以到www.xapware.com/ddg中找到最新的更新版本。本文檔不包括用戶接口標(biāo)準(zhǔn)。本文檔是獨(dú)立的但也是同樣重要的。已經(jīng)有足夠的第三方書籍和Microsoft文檔包括了另外一些指導(dǎo)方針，而我們決定并不復(fù)制這些信息，但我們會(huì)指引你到Microsoft Developers Network 和一些資源，在那兒可以找到你所需的信息。
返回
二、通用源代碼格式規(guī)則
2.1 縮格
縮格是指在每一級(jí)有兩個(gè)空格。不要在源代碼中保留tab字符，這是因?yàn)閠ab字符會(huì)隨著不同用戶的不同設(shè)置和不同的資源管理工具（打印、文檔、版本控制等）而代表不同的寬度。
你可以通過關(guān)閉Environment選項(xiàng)對(duì)話框中Editor頁上的“Use tab character”和“Optimal fill”檢查框（通過Tools|Environment）來禁止保存tab字符。
2.2 頁邊空格
頁邊空格會(huì)被設(shè)置成80字符寬。通常，源碼不會(huì)超出這個(gè)邊界，但這個(gè)方針會(huì)有一些彈性。不管是否有可能，那些超出到另一行的語句會(huì)在一個(gè)逗號(hào)或其他操作符之后與前面的語句相連。當(dāng)一個(gè)語句被打斷相連時(shí)，它應(yīng)比原來的那一行語句縮進(jìn)兩個(gè)字符。
2.3 Begin…End 配對(duì)
Begin 子句應(yīng)寫在獨(dú)立的一行。例如，下面第一行是錯(cuò)誤的寫法而第二行是正確的。
for I := 0 to 10 do begin //錯(cuò)誤，begin同for在同一行
for I := 0 to 10 do //正確，begin出現(xiàn)在獨(dú)立的一行
begin
這個(gè)規(guī)則的例外是當(dāng)begin子句的出現(xiàn)是作為一個(gè)else子句的一部分－參考例子：
if some statement then
begin
…
end
else begin
someOtherStatement;
end;
end 語句永遠(yuǎn)出現(xiàn)在獨(dú)立的一行。
當(dāng)begin語句不是一個(gè)else子句的一部分時(shí)，相應(yīng)的end語句永遠(yuǎn)縮進(jìn)到與begin部分相對(duì)應(yīng)的位置。
返回
三、Object Pascal
3.1 括號(hào)
永遠(yuǎn)不要在括號(hào)與括號(hào)之間的字符中間留下空格。下面的例子示范了錯(cuò)誤的與正確地使用括號(hào)中的空格：
CallProc( Aparameter ); //錯(cuò)誤
CallProc(Aparameter); //正確
永遠(yuǎn)不要在一個(gè)語句中使用不必要的括號(hào)。括號(hào)只應(yīng)在源代碼中需要的地方使用。以下的例子示范了錯(cuò)誤和正確的使用：
if (I = 42) then //錯(cuò)誤 － 多余的括號(hào)
if (I = 42) or (J = 42) then //正確 － 需要括號(hào)
3.2 保留字和關(guān)鍵字
Object Pascal 保留字和關(guān)鍵字永遠(yuǎn)是全部小寫。
3.3 過程和函數(shù)（例程）
3.3.1 命名/格式化
例程的名字永遠(yuǎn)應(yīng)該以大寫的字母開頭并且中間錯(cuò)落分明以便于可讀性。下面是一個(gè)不正確格式的過程名稱：
procedure thisisapoorlyformattedroutinename;
下面是一個(gè)合適的大小寫例程名稱的例子：
procedure ThisIsMuchMoreReadableRoutineName;
例程的名稱應(yīng)該同它的內(nèi)容相符。一個(gè)會(huì)導(dǎo)致某個(gè)行為的例程應(yīng)以動(dòng)詞開頭。例如：
procedure FormatHardDrive;
一個(gè)用于設(shè)置輸入?yún)?shù)的例程應(yīng)以單詞set作為前綴，例如：
procedure SetUserName;
一個(gè)用來接收某個(gè)值的例程應(yīng)以單詞get作為前綴，例如：
procedure GetUserName : string;
3.3.2 形式參數(shù)
3.3.2.1 格式化
如果有的話，相同類型的形參應(yīng)合并在一個(gè)語句中：
procedure Foo(Param1, Param2, Param3 : Integer; Param4 : string);
3.3.2.2 命名
所有形參的名字應(yīng)是十分符合它們所代表的意義，特別是應(yīng)該以傳送到例程中的標(biāo)志符的名稱為基礎(chǔ)。一個(gè)好的參數(shù)名稱應(yīng)以字符A為前綴 － 例如：
procedure SomeProc(AuserName : string; AuserAge : integer);
“A”前綴按約定表示該參數(shù)的名稱是與類類型中的一個(gè)屬性或域的名稱相對(duì)應(yīng)的。
3.3.2.3 參數(shù)的排序
下面的形參的順序重點(diǎn)說明了注冊(cè)者調(diào)用約定調(diào)用的好處。
－ 最常用的參數(shù)應(yīng)放在第一位，其它的參數(shù)應(yīng)按從左到右的順序排列。
－ 輸入?yún)?shù)列表應(yīng)放在輸出參數(shù)列表的左邊。
－ 將通用的參數(shù)放在特殊參數(shù)的左邊，例如：
procedure SomeProc(Aplanet, AContinent, Acountry, Astate, Acity)
－ 排序有可能有些例外，比如事件的處理。類型為TObject的Sender參數(shù)經(jīng)常放在第一位。
3.3.2.4 常量參數(shù)
當(dāng)一個(gè)參數(shù)為記錄型、數(shù)組類型、ShortString、或接口類型并且在例程中不被改變時(shí)，這些參數(shù)應(yīng)做上常量標(biāo)記。這樣做會(huì)讓編譯器更加有效率的產(chǎn)生有關(guān)這些不改變的參數(shù)的代碼。
而例程中另外一些非變參數(shù)也可常量來傳送。盡管這樣做沒有產(chǎn)生任何效果和提高效率，這將會(huì)給調(diào)用例程的使用者提供更多的信息。
3.3.2.5 名稱的沖突
當(dāng)使用擁有兩個(gè)名稱相同的例程的兩個(gè)單元時(shí)，如果你調(diào)用該例程時(shí)，在uses子句中排在后面的單元中的例程將會(huì)被調(diào)用。為了解決這種“在uses子句上的模糊”沖突，要在調(diào)用該例程時(shí)寫上相關(guān)的單元的前綴，例如：
sysUtile.FindClose(SR);
或
windows.FindClose(Handle);
3.4 變量
3.4.1 變量的命名和格式
變量的命名應(yīng)以使用它們的目的相符
循環(huán)控制變量應(yīng)采用一個(gè)單獨(dú)的字符作為名字，比如 I，J，或K，也可以采用更加有意義的名字，比如 UserIndex。
邏輯變量的名字應(yīng)能充分表達(dá)準(zhǔn)確的真或假的意思。
3.4.2 局部變量
一個(gè)過程中的局部變量應(yīng)遵循所有其它變量的使用和命名約定。臨時(shí)變量的取名應(yīng)合理。
如果必須的話，在一進(jìn)入例程就應(yīng)初始化局部變量。局部的AnsiString變量會(huì)自動(dòng)初始化為一個(gè)空的字符串。
局部接口和派分接口類型變量將會(huì)自動(dòng)初始化為nil，并且局部變數(shù)和ole變數(shù)類型變量會(huì)自動(dòng)初始化為Unassigned
3.4.3 全局變量的使用
使用全局變量是不推薦的。但是，在某些時(shí)候還是必須使用，而且它們也只應(yīng)在必須使用的時(shí)候才使用。在這種時(shí)候，你應(yīng)努力只在一段上下文范圍內(nèi)使用全局變量。例如，一個(gè)全局變量只應(yīng)在一個(gè)單元的implemntation部分內(nèi)是全局的。如果打算在多個(gè)單元類使用全局?jǐn)?shù)據(jù)，你應(yīng)將它們移到一個(gè)公共的單元中然后被其它所有單元使用。
全局變量可以在var子句中直接初始化為一個(gè)值。記住，所有的全局?jǐn)?shù)據(jù)會(huì)自動(dòng)初始化為0,因此不要將全局變量初始化為一個(gè)“空”值比如 0、nil、’’、Unassigned、等等。這樣做的一個(gè)理由是因?yàn)榱悖跏蓟娜謹(jǐn)?shù)據(jù)在exe文件中不會(huì)占據(jù)任何空間。零－初始化數(shù)據(jù)被存儲(chǔ)在一個(gè)虛擬的數(shù)據(jù)段，它在應(yīng)用程序啟動(dòng)后被分配在一段內(nèi)存中。非零－初始化的全局?jǐn)?shù)據(jù)在硬盤的exe文件占用空間。
3.5 類型
3.5.1 大寫約定
如果類型的名字是保留字，那么它應(yīng)全部小寫。Win32 API類型通常全部大寫，并且你必須遵循在Windows.pas或其他API單元中的詳細(xì)類型名稱的約定。對(duì)于其他變量名字，地一個(gè)字母應(yīng)為大寫，而其他字母應(yīng)錯(cuò)落有致。下面是一些例子：
var
MyString : string; //保留字
WindowHandle : HWND; //Win32 API 類型
I : Integer; //在System單元中引進(jìn)的類型標(biāo)識(shí)符
3.5.1.1 浮點(diǎn)指針類型
不推薦使用Real類型，因?yàn)樗拇嬖谥皇菫榱讼蚯凹嫒菰缙诘腜ascal代碼。在通常情況下用Double來實(shí)現(xiàn)浮點(diǎn)指針的需要。并且，Double對(duì)處理器和總線而言是做了最優(yōu)化處理的，它也是IEEE中定義的標(biāo)準(zhǔn)數(shù)據(jù)格式。只有當(dāng)需要的范圍超出Double所定義的范圍時(shí)才使用Extended。Extended是intel定義的類型且在Java中不支持。只有當(dāng)浮點(diǎn)指針變量的實(shí)際字節(jié)大小有其意義時(shí)才使用Single。（比如當(dāng)使用另一種語言的DLLs時(shí)）。
3.5.1.2 枚舉類型
枚舉類型的名字需符合使用該類型的目的。該類型的名字需以字符T為前綴，以表明這是一個(gè)類型。枚舉類型中的標(biāo)識(shí)符列表必須包含兩個(gè)或三個(gè)字符的前綴來對(duì)應(yīng)于該枚舉類型的名字 － 例如：
TsongType = (stRock, stClassical, stCountry, stAlternative, stHeavyMetal, stRB);
一個(gè)枚舉類型的實(shí)例的名字應(yīng)與不要前綴的枚舉類型（SongType）相同，除非有更好的原因來賦予該變量更特殊的名字，比如：FavoriteSongType1,FavoriteSongType2 等等。
3.5.1.3 變數(shù)和ole變數(shù)類型
通常不建議使用變數(shù)和Ole變數(shù)類型。但在只有運(yùn)行時(shí)刻才能知道數(shù)據(jù)類型的程序中必須使用該類型，這種情形多出現(xiàn)在COM和數(shù)據(jù)庫開發(fā)中。Ole變數(shù)使用在以COM為基礎(chǔ)的編程中例如自動(dòng)化和ActiveX控制，而變數(shù)使用在非COM的編程中，這是因?yàn)樽償?shù)可以十分有效地存儲(chǔ)本地Delphi字符串（同一個(gè)字符串變量一樣），但Ole變數(shù)會(huì)將所有的字符串轉(zhuǎn)換為Ole字符串（WideChar 字符串）并且并不實(shí)例運(yùn)算 － 它們永遠(yuǎn)拷貝。
3.5.2 結(jié)構(gòu)類型
3.5.2.1 數(shù)組類型
數(shù)組類型的名字需符合它們使用的目的。該類型的名字必須加以前綴T。如果須聲明該數(shù)組類型的指針，那么該指針需加以前綴P而且應(yīng)立即聲明在該數(shù)組聲明的前面。例如：
type
PCycleArray = ^TCycleArray;
TCycleArray = array[1…100] of integer;
在實(shí)際應(yīng)用中，數(shù)組的變量實(shí)例的名稱應(yīng)是其類型的名字去掉前綴T。
3.5.2.2 記錄類型
記錄類型的名字應(yīng)符合使用它們的目的。其類型的聲明應(yīng)加以前綴T。如果要聲明該記錄類型的指針，就應(yīng)加以前綴P并且應(yīng)緊靠在類型聲明的前面聲明。例如：
type
PEmployee = ^TEmployee;
TEmployee = record
EmployeeName : string;
EmployeeRate : Double;
end;
3.6 語句
3.6.1 if 語句
在if/then/else語句中最常發(fā)生的行為應(yīng)放在then子句中，而其它發(fā)生可能性較小的行為應(yīng)放在else子句中。
盡量避免使用嵌套的if語句，在這種情形下應(yīng)用多個(gè)if語句來判斷各種可能。
不要使用if嵌套超過五級(jí)深度。應(yīng)使代碼編寫得更加清晰、明了。
不要在if語句中使用不必要的圓括號(hào)。
如果在if語句中有多個(gè)條件需測試，這些條件應(yīng)按計(jì)算強(qiáng)度由少到多的順序從左到右排列。這樣做能使編譯器在編譯代碼時(shí)獲得布爾估算邏輯的捷徑，從而使你的代碼獲得最佳的優(yōu)化。舉例來說，如果條件1快過條件2，而條件2快過條件3，那么在if語句中的排列應(yīng)是：
if 條件1 and 條件2 and 條件3 then
3.6.2 case 語句
3.6.2.1 一般性話題
在一個(gè)case語句中的各個(gè)獨(dú)立的單元應(yīng)以數(shù)字或字母順序排列。
每一個(gè)case單元的動(dòng)作行為應(yīng)保持簡單而不應(yīng)該超過四到五行代碼。如果所要執(zhí)行的動(dòng)作過于復(fù)雜應(yīng)采用獨(dú)立的過程或函數(shù)。
Case語句中的else子句只有當(dāng)需要缺省行為或處理錯(cuò)誤時(shí)才使用。
3.6.2.2 格式
case語句應(yīng)遵循其它結(jié)構(gòu)的縮格和命名約定。
3.6.3 while 語句
在一個(gè)while語句中不建議使用exit過程來跳出循環(huán)，盡量僅使用循環(huán)條件來跳出循環(huán)。
在一個(gè)while循環(huán)中所用的初始化代碼應(yīng)緊靠在進(jìn)入while循環(huán)前面出現(xiàn)而不要被其它不相關(guān)的語句隔開。
任何結(jié)束后的處理應(yīng)在循環(huán)之后立即進(jìn)行。
3.6.4 for 語句
for語句只有當(dāng)循環(huán)次數(shù)已知的情況下才能取代while語句使用。
3.6.5 repeat 語句
repeat語句的使用同while語句一樣，并且遵循同樣的通用方針。
3.6.6 with 語句
3.6.6.1 一般話題
with語句應(yīng)節(jié)省使用，并且?guī)в写罅康木?。避免過度使用with語句并且在with語句中小心使用多個(gè)對(duì)象、記錄等等。例如：
with Record1, Record2 do
這些事情會(huì)使程序員感到困惑并難以發(fā)現(xiàn)問題所在。
3.6.6.2 格式
with 語句遵循本文檔所說明的命名約定和縮格的格式規(guī)則。
3.7 結(jié)構(gòu)異常處理
3.7.1 一般話題
異常的處理大量地使用在錯(cuò)誤糾正和資源保護(hù)方面。這就是說一旦資源被分配，一個(gè)try…finally必需加以使用來保證該資源被正確的釋放。這種異常的保護(hù)也是指在一個(gè)單元的initializition/finalization或一個(gè)對(duì)象的constructor/destructor中進(jìn)行資源的分配和釋放。
3.7.2 try…finally的使用
任何情形下，每一次的分配都應(yīng)跟隨一個(gè)try…finally。舉例來說，下面的代碼會(huì)造成可能的錯(cuò)誤：
SomeClass1 := TsomeClass.Create;
SomeClass2 ;= TsomeClass.Create;
try
{ do some code }
finally
SomeClass1.Free;
SomeClass2.Free;
end;
一個(gè)更安全更合適的分配過程應(yīng)是：
SomeClass1 := TSomeClass.Create;
try
SomeClass2 := TsomeClass.Create;
try
{ do some code }
finally
SomeClass2.Free;
end;
finally
SomeClass1.Free;
end;
3.7.3 try…except的使用
只有當(dāng)在異常被觸發(fā)而你想執(zhí)行一些任務(wù)時(shí)才使用try…except。通常，你沒有必要為了只是簡單地在屏幕上顯示一個(gè)錯(cuò)誤信息而使用try…except語句，因?yàn)檫@會(huì)被Application對(duì)象自動(dòng)執(zhí)行。如果你想在except子句中執(zhí)行完一些任務(wù)之后調(diào)用缺省的異常處理，使用raise來重新觸發(fā)異常到下一個(gè)句柄。
3.7.4 try…except…else的使用
try…except中的else子句不建議使用，因?yàn)樗鼤?huì)打斷所有的異常包括那些你沒有準(zhǔn)備的異常。
3.8 類類型
3.8.1 命名和格式
類類型的名稱應(yīng)符合使用它們的目的。類型名字應(yīng)加以前綴T以表明這是一個(gè)類型的定義 － 例如：
type
Tcustomer = class(TObject)
類型的實(shí)例通常是沒有前綴T的類型的名字 － 例如：
var
Customer :Tcustomer;
注意：查閱“構(gòu)件類型的命名標(biāo)準(zhǔn)”來獲得更多有關(guān)構(gòu)件命名的信息。
3.8.2 域
3.8.2.1 命名/格式
類的域名遵循與變量標(biāo)識(shí)符同樣的約定除了它們應(yīng)以F為前綴，來表明這是一個(gè)域的名稱。
3.8.2.2 可視化
所有的域都必需是私有的。想在類的范圍之外存取域得通過屬性來使用。
3.8.3 方法
3.8.3.1 命名/格式
方法的命名應(yīng)遵循本文檔中有關(guān)過程和函數(shù)的約定敘述。
3.8.3.2 使用靜態(tài)的方法
如果使用一個(gè)靜態(tài)的方法，那么該方法就不能被該類的后代類所繼承。
3.8.3.3 使用虛擬/動(dòng)態(tài)的方法
如果你打算該類的方法能被后代的類所繼承就得使用虛擬的方法。只有在該方法有多個(gè)繼承時(shí)（直接的或間接的）才使用動(dòng)態(tài)的方法。例如，一個(gè)類類型包含一個(gè)可繼承的方法，而100個(gè)后代類要繼承這種方法，那么這個(gè)方法就會(huì)動(dòng)態(tài)地產(chǎn)生為100個(gè)后代類使用的內(nèi)存。
3.8.3.4 使用抽象的方法
如果在一個(gè)類中使用抽象的方法，該類就不能被創(chuàng)建。只有在那些永遠(yuǎn)不會(huì)被創(chuàng)建的類中使用抽象的方法。
3.8.3.5 屬性存取方法
所有存取類的方法都只能出現(xiàn)在類的private或protected部分。屬性存取方法的命名應(yīng)遵循過程和函數(shù)的約定規(guī)則。讀取存取方法（方法讀取器）必需以單詞Get為前綴。寫入存取方法（方法寫入器）必需以單詞Set為前綴。方法寫入器的參數(shù)的名字應(yīng)為Value，并且它的類型應(yīng)是它所操作的屬性的類型。例如：
TSomeClass = class(TObject)
private
FsomeField : Integer;
protected
function GetSomeField : Integer;
procedure SetSomeField(Value : Integer);
public
property SomeField : Integer read GetSomeField write SetSomeField;
end;
3.8.4 屬性
3.8.4.1 命名/格式
屬性如果是表示為一個(gè)私有域的存取器的話，那么它的名字應(yīng)是它們所操作的域的名字除去解釋符F。
屬性的名字應(yīng)是名詞，不是動(dòng)詞。屬性表示的是數(shù)據(jù)，而方法表示的是行為。
數(shù)組類型的名稱應(yīng)為復(fù)數(shù)。一般情況下屬性的名稱應(yīng)為單數(shù)。
3.8.4.2 使用存取的方法
盡管沒有要求，但還是建議盡量少地為一個(gè)表示私有域的屬性而使用寫入存取方法。
返回
四、文件
4.1 工程文件
4.1.1 命名
工程文件應(yīng)取個(gè)描述性的名字。例如，Delphi 4開發(fā)者指南錯(cuò)誤管理器 的工程名字是：DDGBugs.dpr。一個(gè)有關(guān)系統(tǒng)信息的程序的名字就應(yīng)象 SysInfo.dpr。
4.2 窗體文件
4.2.1 命名
一個(gè)窗體文件的取名應(yīng)可以描述使用該窗體的目的，并加以后綴Frm。例如，一個(gè)“關(guān)于”的窗體的文件名應(yīng)是AboutFrm.dpr。主窗體的文件名應(yīng)是MainFrm.dpr。
4.3 數(shù)據(jù)模板文件
4.3.1 命名
數(shù)據(jù)模板的取名應(yīng)能表示使用該數(shù)據(jù)模板的目的，它的名稱應(yīng)加以兩個(gè)字符的后綴DM。例如，自定義數(shù)據(jù)模板的文件名字應(yīng)為CustomersDM.dfm。
4.4 遠(yuǎn)端數(shù)據(jù)模板文件
4.4.1 命名
遠(yuǎn)端數(shù)據(jù)模板的取名應(yīng)能表示使用該遠(yuǎn)端數(shù)據(jù)模板的目的，它的名稱應(yīng)加以三個(gè)字符的后綴RDM。例如，自定義遠(yuǎn)端數(shù)據(jù)模板的文件名字應(yīng)為CustomersRDM.dfm。
4.5 Unit文件
4.5.1 通用Unit結(jié)構(gòu)
4.5.1.1 unit的名字
Unit文件應(yīng)取一個(gè)可描述性的名字。例如，包含應(yīng)用程序主窗體的單元應(yīng)叫做MainFrm.pas。
4.5.1.2 uses子句
在interface部分的uses子句應(yīng)包含在interface部分中的代碼所需要的單元。去掉那些Delphi可以自動(dòng)加入到程序中的單元。
在implementation部分的uses子句應(yīng)只包含在implementation部分中的代碼所需要的單元的名字。去掉不必要的單元。
4.5.1.3 interface部分
interface部分應(yīng)包含只那些其它單元所需要存取類型的定義、變量、過程/函數(shù)的預(yù)定義等等。否則，就應(yīng)放在implementation部分定義。
4.5.1.4 implementation部分
implementation部分應(yīng)包含那些只在本單元中私用的類型定義、變量、過程/函數(shù)定義等等。
4.5.1.5 initialization部分
不要在initialization 部分放入耗時(shí)長的代碼，這將使程序的第一個(gè)界面出現(xiàn)
得比較緩慢。
4.5.1.6 finalization部分
在這里要保證釋放你在Initialization部分所分配的任何資源。
4.5.2 窗體單元
4.5.2.1 命名
一個(gè)窗體的單元文件應(yīng)擁有與它所對(duì)應(yīng)的窗體文件同樣的名稱。例如，“關(guān)于”窗體的單元名稱應(yīng)為 AboutFrm.pas，而主窗體的單元名稱應(yīng)為MainFrm.pas。
4.5.3 數(shù)據(jù)模板單元
4.5.3.1 命名
一個(gè)數(shù)據(jù)模板的單元文件應(yīng)擁有與它所對(duì)應(yīng)的數(shù)據(jù)模板文件同樣的名稱。例如，一個(gè)自定義數(shù)據(jù)模板單元的名稱應(yīng)為CustomersDM.pas。
4.5.4 一般目的單元
4.5.4.1 命名
一般目的單元的取名應(yīng)符合使用該單元的目的。例如，一個(gè)實(shí)用程序單元取名為BugUtilities.pas。一個(gè)包含全局變量的單元取名為CustomerGlobals.pas。
注意，該單元的名字不能與它的工程中所使用的所有包中的單元的名字相同。不贊成使用一般的或通用的單元名字。
4.5.5 構(gòu)件單元
4.5.5.1 命名
構(gòu)件單元應(yīng)放在獨(dú)立的目錄，以將它們同定義構(gòu)件組或構(gòu)件集合的單元區(qū)分開來。它們要永遠(yuǎn)同工程在不同的目錄。單元名字應(yīng)同它們的內(nèi)容相符。
注意：查閱“用戶定義的構(gòu)件”部分來獲得更多有關(guān)構(gòu)件命名標(biāo)準(zhǔn)的信息。
4.6 文件頭
建議在所有源文件、工程文件、單元等等中使用信息化文件頭。一個(gè)良好的文件頭應(yīng)包含以下信息：
｛
版權(quán)… 著作的年、月、日…
}
返回
五、窗體和數(shù)據(jù)模板
5.1 窗體
5.1.1 窗體類型命名標(biāo)準(zhǔn)
窗體類型的取名應(yīng)能表達(dá)使用該窗體的目的。類型定義應(yīng)加以前綴T。前綴后面跟隨著描述性的名字。最后，應(yīng)加以Form后綴來描述名字。例如，一個(gè)“關(guān)于”的窗體的類型的名字應(yīng)為：
TAboutFrom = class(TForm);
主窗體的定義為：
TMainForm = class(TForm);
一個(gè)用戶接入窗體的名字應(yīng)象：
TCustomerEntryForm = class(TForm);
5.1.2 窗體實(shí)例命名標(biāo)準(zhǔn)
窗體實(shí)例應(yīng)是沒有帶前綴T的相應(yīng)類的名字。例如，對(duì)應(yīng)于前面窗體類型而言，其實(shí)例的名字應(yīng)為：
類型名稱 實(shí)例名稱
TAboutForm AboutForm
TMainForm MainForm
TCustomerEntryForm CustomerEntryForm
5.1.3 自動(dòng)創(chuàng)建窗體
只有主窗體可以是自動(dòng)創(chuàng)建的除非有其它更好的理由不這樣做。所有其它的窗體必需從工程選項(xiàng)對(duì)話框中的自動(dòng)創(chuàng)建列表中移走。查閱以下部分來獲得更多的信息。
5.1.4 模式窗體實(shí)例化函數(shù)
所有的窗體單元都應(yīng)包含一個(gè)窗體實(shí)例化函數(shù)，該函數(shù)用來創(chuàng)建、設(shè)置、模式地顯示窗體，并釋放窗體。該函數(shù)應(yīng)返回窗體的模式結(jié)果。該函數(shù)要傳遞的參數(shù)應(yīng)遵循本文檔指定的“參數(shù)傳遞”標(biāo)準(zhǔn)。通過這種方式封裝的函數(shù)性有助于代碼的再利用和維護(hù)。
該窗體的變量要從單元中移走，并再窗體實(shí)例的函數(shù)中進(jìn)行本地式地定義。注意，這就意味著該窗體必需從工程/選項(xiàng)對(duì)話框中的自動(dòng)創(chuàng)建列表中剔除。參考本文檔后面的“自動(dòng)創(chuàng)建窗體”。
例如，下面的單元展示了再GetUserData窗體中的一個(gè)函數(shù)。
unit UserDataFrm;
interface
uses
windows, Messages, SysUtils, Classes, Graphics, Controls, Forms,
Dialogs, StdCtrls;
type
TUserDataForm = class(TForm)
edtUserName : TEdit;
edtUserID : TEdit;
private
{ Private declarations }
public
{ Public declarations }
end;
function GetUserData(var aUserName ： String; var aUserID : Integer) :
Word;
implementation
{$R *.DFM }
function GetUserData(var aUserName : String; var aUserID : Integer) :
word;
var
UserDataForm : TuserDataForm;
begin
UserDataForm := TuserDataForm.Create(Application);
try
UserDataForm.Caption := ‘Getting User Data’;
Result := UserDataForm.ShowModal;
if (Result = mrOK) then
begin
aUserName := UserDataForm.edtUserName.Text;
aUserID := StrToInt(UserDataForm.edtUserID.Text);
end;
finally
UserDataForm.Free;
end;
end;
end.
5.2 數(shù)據(jù)模板
5.2.1 數(shù)據(jù)模板命名標(biāo)準(zhǔn)
數(shù)據(jù)模板的取名要符合使用該數(shù)據(jù)模板的目的。類型的定義應(yīng)加以前綴T，后面緊接著描述性的名字，最后要加以后綴單詞“DataModule”。例如，一個(gè)自定義的數(shù)據(jù)模板有時(shí)候應(yīng)該象：
TCustomerDataModule = class(TDataModule)
一個(gè)命令式的數(shù)據(jù)模板的名字應(yīng)象：
TOrdersDataModule = class(TDataModule)
5.2.2 數(shù)據(jù)模板實(shí)例命名標(biāo)準(zhǔn)
數(shù)據(jù)模板實(shí)例的名稱應(yīng)是對(duì)應(yīng)不帶前綴T的類型的名稱。例如，對(duì)于前面的窗體類型而言，其實(shí)例的名稱應(yīng)為：
類型名稱 實(shí)例名稱
TCustomerDataModule CustomerDataModule
TOrdersDataModule OrdersDataModule
返回
六、包
6.1 使用運(yùn)行包和設(shè)計(jì)包的比較
運(yùn)行時(shí)刻的包應(yīng)只包含其它構(gòu)件包所要求的單元或構(gòu)件。另外，包含屬性/構(gòu)件編輯器和其它只為設(shè)計(jì)的代碼應(yīng)放入到設(shè)計(jì)時(shí)刻包中。注冊(cè)單元應(yīng)放在設(shè)計(jì)包中。
6.2 文件命名標(biāo)準(zhǔn)
包的名稱應(yīng)依照下面的例子：
“iiilibvv.pkg” － 設(shè)計(jì)時(shí)刻包
“iiistdvv.pkg” － 運(yùn)行時(shí)刻包
字符“iii”表示一個(gè)3字符標(biāo)識(shí)前綴。這個(gè)前綴用來表明公司、個(gè)人或其它有標(biāo)識(shí)意義的實(shí)體。
字符“vv”表示為該包想要對(duì)應(yīng)Delphi某個(gè)版本的包的版本號(hào)。
注意，包的名字中包含“lib”或“std”的意思是表明這是一個(gè)設(shè)計(jì)時(shí)刻包還是一個(gè)運(yùn)行時(shí)刻包。
如果既是設(shè)計(jì)時(shí)刻包又是運(yùn)行時(shí)刻包，該文件的命名是同上面一樣的，例如，為Delphi 4開發(fā)者指南做的包的名稱應(yīng)為：
DdgLib40.pkg – 設(shè)計(jì)時(shí)刻包
DdgStd40.pkg – 運(yùn)行時(shí)刻包
返回
七、構(gòu)件
7.1 用戶自定義構(gòu)件
在標(biāo)準(zhǔn)構(gòu)件中命名出來的構(gòu)件的名稱同在“類類型”部分定義中的一樣定義成一個(gè)類類型，不同的是它們有一個(gè)3字符的指示前綴，這個(gè)前綴可以表示公司、個(gè)人或其它實(shí)體。例如，一個(gè)為Delphi 4開發(fā)者指南編寫的時(shí)鐘構(gòu)件的名稱定義為：
TddgClock = class(TComponent)
注意，那三個(gè)前綴字符是小寫的。
7.2 構(gòu)件單元
構(gòu)件單元應(yīng)只包含一個(gè)主要的構(gòu)件，一個(gè)主要的構(gòu)件是指出現(xiàn)在構(gòu)件欄中的構(gòu)件。主要構(gòu)件的輔助構(gòu)件/對(duì)象應(yīng)放入到同一個(gè)單元中。
7.3 使用注冊(cè)單元
構(gòu)件的注冊(cè)過程應(yīng)從構(gòu)件本身的單元中剔除，并放入到一個(gè)獨(dú)立的單元中。這個(gè)注冊(cè)單元可以用來注冊(cè)任何構(gòu)件、屬性編輯器、構(gòu)件編輯器、專家器等。
構(gòu)件的注冊(cè)只應(yīng)在設(shè)計(jì)時(shí)刻包中進(jìn)行，注冊(cè)單元應(yīng)包含在設(shè)計(jì)時(shí)刻包中而不應(yīng)放在運(yùn)行時(shí)刻包中。
推薦使用的注冊(cè)單元的名稱是：
XxxReg.pas
上面的3個(gè)前綴字符“Xxx”用來表示一個(gè)公司、個(gè)人或任何其它的實(shí)體。例如，在Delphi 4 開發(fā)者指南中的注冊(cè)單元的名稱應(yīng)為 DdgReg.pas。
7.4 構(gòu)件實(shí)例命名約定
所有的構(gòu)件都應(yīng)取個(gè)描述性的名稱。由Delphi創(chuàng)建的缺省名的構(gòu)件不會(huì)被遺棄。在設(shè)計(jì)構(gòu)件類型時(shí)應(yīng)設(shè)計(jì)一個(gè)小寫的前綴。使用前綴而不使用后綴的原因是在搜尋時(shí)，在對(duì)象檢查器和代碼探索器中搜尋構(gòu)件的名字比搜尋構(gòu)件的類型更容易實(shí)現(xiàn)。
7.5 構(gòu)件的前綴
以下構(gòu)件的前綴可以用來設(shè)計(jì)Delphi 4中的標(biāo)準(zhǔn)構(gòu)件。請(qǐng)?jiān)诖肆斜碇屑尤氲谌綐?gòu)件的前綴。
7.6 Standard頁
前綴 構(gòu)件
mm TMainMenu
pm TPopupMenu
mmi TMainMenuItem
pmi TPopupMenuItem
前綴 構(gòu)件
lbl TLabel
edt TEdit
mem TMemo
btn TButton
cb TCheckBox
rb TRadioBox
lb TListBox
cb TComboBox
scb TScrollBar
gb TGroupBox
rg TRadioGroup
pnl TPanel
cl TCommandList
7.7 Additional頁
bbtn TBitBtn
sb TSpeedButton
me TMaskEdit
sg TStringGrid
dg TDrawGrid
img TImage
shp TShape
bvl TBevel
sbx TScrollBox
clb TCheckListbox
spl TSplitter
stx TStaticText
cht TChart
7.8 Win32頁
tbc TTabControl
pgc TPageControl
il TImageList
re TRichEdit
thr TTrackBar
prb TProgressBar
ud TUpDown
hk THotKey
ani TAnimate
dtp TDateTimePicker
tv TTreeView
lv TListView
hdr THeaderControl
前綴 構(gòu)件
stb TStatusBar
tlb TToolBar
clb TCoolBar
7.9 System頁
tm TTimer
pb TPaintBox
mp TMediaPlayer
olec TOleContainer
ddcc TDDEClientItem
ddci TDDEClientItem
ddsc TDDEServerConv
ddsi TDDEServerItem
7.10 Internet頁
csk TClientSocket
ssk TServerSocket
wbd TWebDispatcher
pp TPageProducer
tp TQueryTableProducer
dstp TDataSetTableProducer
nmdt TNMDayTime
nec TNMEcho
nf TNMFinger
nftp TNMFtp
nhttp TNMHttp
nMsg TNMMsg
nmsg TNMMSGServ
nntp TNMNNTP
npop TNMPop3
nuup TNMUUProcessor
smtp TNMSMTP
nst TNMStrm
nsts TNMStrmServ
ntm TNMTime
nudp TNMUdp
psk TPowerSock
ngs TNMGeneralServer
html THtml
url TNMUrl
sml TSimpleMail
7.11 Data Access頁
前綴 構(gòu)件
ds TDataSource
tbl TTable
qry TQuery
sp TStoredProc
db TDataBase
ssn TSession
bm TBatchMove
usql TUpdateSQL
7.12 Data Controls頁
dbg TDBGrid
dbn TDBNavigator
dbt TDBText
dbe TDBEdit
dbm TDBMemo
dbi TDBImage
dblb TDBListBox
dbcb TDBComboBox
dbch TDBCheckBox
dbrg TDBRadioGroup
dbll TDBLookupListBox
dblc TDBLookupComboBox
dbre TDBRichEdit
dbcg TDBCtrlGrid
dbch TDBChart
7.13 Decision Cube頁
dcb TDecisionCube
dcq TDecisionQuery
dcs TDecisionSource
dcp TDecisionPivot
dcg TDecisionGrid
dcgr TDecisionGraph
7.14 QReport頁
qr TQuickReport
qrsd TQRSubDetail
qrb TQRBand
qrcb TQRChildBand
qrg TQRGroup
qrl TQRLabel
前綴 構(gòu)件
qrt TQRText
qre TQRExpr
qrs TQRSysData
qrm TQRMemo
qrrt TQRRichText
qrdr TQRDBRichText
qrsh TQRShape
qri TQRImage
qrdi TQRDBMImage
qrcr TQRCompositeReport
qrp TQRPreview
qrch TQRChart
7.15 Dialogs頁
對(duì)話框構(gòu)件是由構(gòu)件封裝的真正的窗體，因此，它們應(yīng)遵循窗體的命名約定。類型已由構(gòu)件的名稱定義。它的實(shí)例的名稱是Delphi自動(dòng)生成的類型實(shí)例名字去掉數(shù)字后綴。舉例如下：
類型 實(shí)例名字
TOpenDialog OpenDialog
TSaveDialog SaveDialog
TOpenPictureDialog OpenPictureDialog
TSavePictureDialog SavePictureDialog
TFontDialog FontDialog
TColorDialog ColorDialog
TPrintSetupDialog PrintSetupDialog
TFindDialog FindDialog
TReplaceDialog ReplaceDialog
7.16 Win3.1頁
dbll TDBLookupList
dblc TDBLookupCombo
ts TTabSet
ol TOutline
tnb TTabbedNoteBook
nb TNoteBook
hdr THeader
flb TFileListBox
dlb TDirectoryListBox
dcb TDriveComboBox
fcb TFliterComboBox
7.17 Samples頁
gg TGauge
前綴 構(gòu)件
cg TColorGrid
spb TSpinEdit
spe TSpinEdit
dol TDirectoryOutline
cal TCalendar
ibea TIBEventAlerter
7.18 ActiveX頁
cfx TChartFX
vsp TVSSpell
f1b TF1Book
vtc TVTChart
grp TGraph
7.19 Midas頁
prv TProvider
cds TClientDataSet
qcds TQueryClientDataSet
dcom TDCOMConnection
olee TOleEnterpriseConnection
sck TSocketConnection
rms TRemoteServer
mid TMidasConnection
本站僅提供存儲(chǔ)服務(wù)，所有內(nèi)容均由用戶發(fā)布，如發(fā)現(xiàn)有害或侵權(quán)內(nèi)容，請(qǐng)
點(diǎn)擊舉報(bào)。
