Delphi開(kāi)發(fā)規(guī)范標(biāo)準(zhǔn)

1、-!Delp hi開(kāi)發(fā)規(guī)范Del phi版本統(tǒng)一使用Delphi2007進(jìn)行項(xiàng)目開(kāi)發(fā)、小部分模塊（比如：系統(tǒng)構(gòu)子模塊Dll、DeIphi2007編譯出問(wèn)題的功能）可以使用Delphi7開(kāi)發(fā)Dll文件，供Delphi2007編寫(xiě)的主程序調(diào)用。當(dāng)需要Delphi2007以上版本進(jìn)行開(kāi)發(fā)時(shí)，必須要滿足使用Delphi新特性才能完成新功能的條件。Del phi插件統(tǒng)一使用以下2款Del phi第三方插件來(lái)提高工作效率。1) Cn Wizards 是一組集成在 Del phi / C+ Builder的 IDE 中,用于增強(qiáng)IDE功能、提高IDE的可用性及開(kāi)發(fā)效率的免費(fèi)、 開(kāi)放源碼工具。2） Del p

2、hi2007以下版本：DelForEx p是一款Del phi代碼格式化工具。該工具重點(diǎn)設(shè)置如下圖：縮進(jìn)空格數(shù)必須為4。在*try信句塊內(nèi)的隹15共健字綿進(jìn)編譯捋令設(shè)置格式化選項(xiàng)編進(jìn)1空榕f換疔I大寫(xiě) 對(duì)芥卩耳他f砸監(jiān) 縮聲髄量：在以下選頂應(yīng)坤縮講：關(guān)鍵宇前不使用貓進(jìn)飛聽(tīng)5咲鍵字在吩二y語(yǔ)句與內(nèi)的性詩(shī)觀宇M« miBi nu TiI. r > * . iT r iT"o*I 確定 I 題消 I 默認(rèn) | lrl邊d風(fēng)格I I 幫助 I般格式規(guī)范1.縮進(jìn)統(tǒng)一使用4個(gè)空格縮進(jìn)。參照下圖進(jìn)行設(shè)置：把Tab的空格數(shù)設(shè)置為4，以后一按tab鍵可以一次縮進(jìn)4個(gè)空格。Opt iOT

3、IS二 BivroiiRieriC Optlcrs； Object IrispectorB Tool Falette 匚 dIcts Envih-onmsrt Vsristlec Explorerb DE口h OptionsType LijrcryLibra-y - Vfln32VCL l>®nmrEeftor OptionsU I “ 01 l, 0l 11 ” _ 一 1 Source Ctotons i colorOispleyKey l*apoirs Code In?iaht-HfTTdL/ASP.hFTOphirHTML Fdmjttng E HTML Ticy op

4、tions T的s WebSrap-r1 . L：-T1 - /-Hi_ L：l< I 山 rIbouroe type; FascdlE：lsn<iofE; pasjdprj d*； nu dfinn; sfniirfmjdpki Keep trai ng blanks I Show tab character r| SSoAf fQ.Kt<h bricter H Uw itdx lily'illyhL 二IShcJne breaks Pl Hiahlichh curent IneE&Jto indent rnode包rt tab0 <u( jui U

5、wubyl I Qptimg hl0 Backspace inin tents2. Begi n.E ndj I DeleteOKCartelHeb Ibegin語(yǔ)句和end語(yǔ)句在源程序中要獨(dú)占一行，例如for I := 0 to 10 do beg in /不正確的用法end;for I := 0 to 10 do /正確的用法begin end;3.空格在操作符及邏輯判斷符號(hào)的兩端添加空格，例如:I := I + 1;，a andb等，但添加括號(hào)時(shí)不需要空格。例如:if ( a > b ) the n /錯(cuò)誤的用法If (a > b) the n /正確的用法又例如:p roc

6、edure Test( Param1: in teger; P aram3: stri ng);4.過(guò)程和函數(shù) 1）命名及格式過(guò)程和函數(shù)的名稱應(yīng)全部使用有意義的單詞組成， 并且所有單詞的第 一個(gè)字母應(yīng)該使用大寫(xiě)字母。例 如:P rocedure formatharddisk;/不正確的命名P rocedure FormatHardDisk;/正確的命名 設(shè)置變量?jī)?nèi)容的過(guò)程和函數(shù)，應(yīng)使用 Set作為前綴，例如:P rocedure SetUserName;讀取變量?jī)?nèi)容的過(guò)程和函數(shù)，應(yīng)使用 Get作為前綴，例如:Fun cti on GetUserName:stri ng;2）注釋1）、除控件產(chǎn)生

7、的事件以外的自定義函數(shù)都必須加入以下格式的注釋。/<summary>/過(guò)程名:函數(shù)中文描述/作者:作者姓名/日期:年-月-日/</summary>/vparam name="參數(shù)名"> 函數(shù)描述 </param>/<returns> 返回值描述，例如：0 -成功；1 -失敗v/returns>2）、所有定義的變量、常量、類都必須加入以下格式注釋/ vsummary>Ill執(zhí)行SQLIII <lsummary>StrSQL:stri ng;3)過(guò)程和函數(shù)的參數(shù)A. 格式統(tǒng)一類型的參數(shù)寫(xiě)在同一句中：P

8、 rocedure Foo(P arami, Param2:l nteger;l nfoStri ng);B. 命名所有參數(shù)必須是有意義的；并且當(dāng)參數(shù)名稱和其它屬性名稱或全局變量重了的時(shí)候，加一個(gè)前綴 A ,例如:P rocedure Some Proc(AUserName: stri ng; AUserAge: in teger);C. 命名沖突當(dāng)使用的兩個(gè)unit中包括一個(gè)重名的函數(shù)或過(guò)程時(shí)，那幺當(dāng)你引用這一函數(shù)或過(guò)程時(shí)，將執(zhí)行在use子 句中后聲明的那個(gè)unit 中的函數(shù)或過(guò)程。為了避免這種 uses-clause-de pen de nt '需要在引用函數(shù)或過(guò)程時(shí)，寫(xiě)完整函數(shù)或

9、過(guò)程的出處。例如:SysUtils.Fi ndClose(SR);Win dows.Fi ndClose(Ha ndle);5.變量1)變量命名及格式首先所有變量必須起有意義的名字，使其它組員可以很容易讀懂變量所代表的意義，變量命名可以采用同義的英文命名， 可使用幾個(gè)英文 單詞，但每一單詞的首字母必須大寫(xiě)。 例如:varWriteFormat:Stri ng同時(shí)對(duì)于一些特定類型可采用一定的簡(jiǎn)寫(xiě)如下: 指針類型P 紀(jì)錄類型Rec 數(shù)組類型Arr類 Class循環(huán)控制變量通常使用單一的字符如:或k。另外使用一個(gè)有意義的名字例如：UserIndex，也是準(zhǔn)許的。2）局部變量在過(guò)程中使用局部變量遵循變

10、量的命名規(guī)則。3）全局變量盡量不使用全局變量，如必須使用全局變量則必須加前綴g_'同時(shí)應(yīng)在變量名稱中體現(xiàn)變量的類型。例如：g_UserCount: point;/名稱為UserCount的全局變量，其類型為指向一結(jié)構(gòu)的指針但是在模塊內(nèi)部可以使用全局變量。所有模塊內(nèi)全局變量必須用F為前綴。如果幾個(gè)模塊之間需要進(jìn)行資料交換， 則需要通過(guò)聲明屬性的方 法來(lái)實(shí)現(xiàn)。例如:TypeTFormOverdraftRetur n 二 class(TForm)p rivate P rivate declarati ons FuserName: stri ng;FuserC ount: In teger;P

11、rocedure SetUserName(Value: stri ng);Fun cti on GetUserName: stri ng;p ublic P ublic declarati ons property UserName: string read GetUserNamewrite SetUserName;property UserCount: Integer read FuserCount write FuserCount;end;6. 類型 1）大小寫(xiě)協(xié)議Win32API的類型通常全部大寫(xiě)，其他的數(shù)據(jù)類型則首字母大寫(xiě)，其余字母小寫(xiě)，例如:varMyStri ng: Stri ng

12、; /除Win32 API以外的數(shù)據(jù)類型I: In teger;/除Win32 API以外的數(shù)據(jù)類型Win dowHa ndle: HWND;Win32 API數(shù)據(jù)類型2）浮點(diǎn)類型盡量不使用Real類型，他只是為了和舊的Pascal代碼兼容，盡量 使用Double類型。Double類型是對(duì)處理器和數(shù)據(jù)總線做過(guò)最優(yōu)化的并且是IEEE定義的標(biāo)準(zhǔn)數(shù)據(jù)結(jié)構(gòu)。當(dāng)數(shù)值超出Double的范圍時(shí)，使用Extended。但Extended不被Jave支持。但使用其它語(yǔ) 言編寫(xiě)的DLL時(shí)可能會(huì)使用Single 類型。3）枚舉類型枚舉類型的名字必須有意義并且類型的名字之前要加前綴 T'枚舉類型的內(nèi)容的名字必

13、須包含枚舉類型名稱的簡(jiǎn)寫(xiě)，例如:TSongType = (stRock, stClassical, stCo un try, stAlternative, stHeavyMetal, stRB);4）數(shù)組類型數(shù)組類型的名字必須有意義并且類型的名字之前要加前綴 T'。如果聲明一個(gè)指向數(shù)組類型的指針必須 在該類型的名字之前加前綴 P'，例如：type P CycleArray =八TCycleArray;TCycleArray = array1.100 of In teger;5）記錄類型記錄類型的名字必須有意義并且類型的名字之前要加前綴 T'。如果聲明一個(gè)指向數(shù)組類型的指

14、針必須 在該類型的名字之前加前綴 P'，例如:TypePEmp loyee =八TE mp loyee;TEmpIo yee = RecordEmpio yeeName: Stri ng;Empio yeeRate: Double;end;7. 類1)命名及格式類的名字必須有意義并且類型的名字之前要加前綴 T'例如:TypeTCustomer = class(TObject)類實(shí)例的名字通常是去掉 T'的類的名字。例如: var Customer: TCustomer;2)類中變量的命名及格式類中變量的名字必須有意義并且類型的名字之前要加前綴F'。所有 的變量必

15、須是要有的。如果需要從外部訪問(wèn)此變量則需要聲明該變量 的屬性。3) 類屬性的訪問(wèn)方法所有的屬性訪問(wèn)方法必須出現(xiàn)在private 或protected 中。屬性訪問(wèn)方法的命名同函數(shù)和過(guò)程的命名另外讀方法(reader method)必須使用前綴 Get'.寫(xiě)方法(writer method)必須使用前綴 Set '。寫(xiě)方法的參數(shù)必須命 名為Value'其類型同所要寫(xiě)的屬性相一致。例如:TSomeClass = class(TObject) p rivateFSomeField: In teger;p rotected fun cti on GetSomeField: In

16、 teger;p rocedure SetSomeField( Value: In teger);p ublic property SomeField: In teger read GetSomeField writeSetSomeField;end;4）屬性的命名及格式同其用操作的，出去前綴 F'的類的變量的名稱相一致。8. 項(xiàng)目 1）項(xiàng)目代碼目錄結(jié)構(gòu)程序主目錄-Bin （應(yīng)用程序所在路徑）-Db （本地?cái)?shù)據(jù)庫(kù)所在路徑）-Doc （文檔所在路徑）-Hlp （幫助文件所在路徑）-Backup （備份路徑）-Tmp （臨時(shí)文件路徑）2）項(xiàng)目的命名項(xiàng)目文件必須使用一個(gè)有意義的名字，項(xiàng)目命名

17、可以采用同義的英文命名，可使用幾個(gè)英文單詞，但每一單詞的首字母必須大寫(xiě)。例如：Del phi中系統(tǒng)信息的項(xiàng)目文件被命名為 SysI nfo.dpr 。3）普通Unit文件命名unit文件的命名應(yīng)該有意義，并且使用Unit_ '作為前綴。例如：通用 Unit 被命名為 Unit_PublicFunction.pas'。4) Form Units 命名Form Unit文件的名字必須和Form的名稱保持一致。例如：主窗體叫Mai nForm貝J Form Un it 文件的名字為:Uni t_FormMa in.pas5) Data Module Un its 命名Data Mod

18、ule unit文件的名字必須和 Data Module 的名稱保持致。例如：Data Module 叫 DMMain.pas 主 貝J Data Module Unit文件的名字為：Unit DMMaino9.Form 類1)2)Form類命名標(biāo)準(zhǔn)Forms類的命名應(yīng)該有意義，命名可以采用同義的英文命名，可使用幾個(gè)英文單詞， 但每一單詞的首字母必須 大寫(xiě)。并且使用 T作為前綴。Form類命名規(guī)則：“ T” + “窗體描述的單詞組合” +” Form”。例如：About Form 類的名字為：TAboutForm = class(TForm)主窗體的名字為T(mén)Main Form = class(

19、TForm)Form類實(shí)例的命名標(biāo)準(zhǔn)Form的類實(shí)例的名字應(yīng)同期掉 T的Form類的名字相一致。Form實(shí)例命名規(guī)則：“窗體描述的單詞組合” +” Form”。例如:類名：TAboutFormForm類實(shí)例：AboutForm類名：TCustomerEntryFormForm類實(shí)例：CustomerEntryForm10. 控件1）控件的命名控件的實(shí)例應(yīng)使用去掉 T'該控件類的名稱作為前綴，所有控件的類名和實(shí)例名都必須使用相關(guān)的描述單詞組合，不能使Delphi默認(rèn)生成的控件類名和實(shí)例名?？丶惷?guī)則：“T” + “控件名稱/簡(jiǎn)稱” + “描述的單詞組合” +序號(hào)。例如：TEdit控件

20、的類名:TEdit UserName?？丶?shí)例命名規(guī)則：“控件名稱/簡(jiǎn)稱” + “窗體描述的單詞組合”例如：TEdit控件的實(shí)例名:edt UserName。2）控件的簡(jiǎn)寫(xiě)控件的名稱可使用以下簡(jiǎn)寫(xiě)。Standard Tab :mm TMai nMenu pm TPopupMenu mmi TMainMen ultem pmi TPopupMen ultemIbl TLabel edt TEdit mem TMemo btn TButton chb TCheckBox rb TRadioButton lb TListBox cb TComboBox scb TScrollBar gb TGro up Box rg TRadioGro up pni TPanel cl TComma ndListAdditi onal Tab bbtn TBitBtn sb TSp eedButt on me TMaskEdit sg TStri ngGrid dg TDrawGrid img TImage s