Delphi編程-程序代碼編寫規(guī)范

1、附錄A 編碼規(guī)范管理程序代碼編寫規(guī)范通常一個(gè)大型應(yīng)用系統(tǒng)，都是由多人共同完成的。在這種環(huán)境下如何實(shí)這里，除了以上講到的命令和界面要一致外，還包括程序代碼的規(guī)范?，F(xiàn)相互之間的交流呢，這就要求同一個(gè)程序組的編程風(fēng)格要基本一致。 而程序代碼的規(guī)范主要有以下幾個(gè)方面的內(nèi)容：一、代碼及注釋規(guī)范1. 代碼中所有保留字的大小寫要一致，這里我們規(guī)定都用小寫；2. 注釋要求：l 單元的頭注釋中要求指明的項(xiàng)目如下示例：(* * 建立日期：年 月 日；* 作 者：* 最近更新時(shí)間：* 單元主要功能描述：* 修改記錄* =* 修改日期：* 修改原因：* 修改簡(jiǎn)要情況：*)l 過程和函數(shù)注釋中除了指明該過程或函數(shù)的功能

2、外，在該過程或函數(shù)中的重要方法的語句的作用都要加注（顯而易見的語句除外，當(dāng)然這個(gè)度是靠每個(gè)人自己把握）。l 公用變量也要求被注釋，以說明該變量的用途。3. 變量申明位置要求： l 公用變量要求在public部分申明；l 私有變量要求在private部分申明；l 對(duì)于用作for循環(huán)的變量，如i、j、k等應(yīng)該在使用該變量的過程或函數(shù)中去申明，不得在public、privatel for循環(huán)的變量一樣，應(yīng)在使用該變量的過程或函數(shù)中去申明。4. 引用單元位置要求：程序單元的引用可以在接口部分引用，也可執(zhí)行部分引用。一般情況下接口部分引用系統(tǒng)單元，而自定義單元在執(zhí)行部分引用（如果自定義單元在接口部分引用

3、請(qǐng)參見第2小點(diǎn)的注釋及要求）。如，implementationusesDataMod, Data Module BrCstOrd, The Browse Orders by Customer form BrParts, The Browse Parts form EdOrders； The Edit Orders form 當(dāng)兩個(gè)或兩個(gè)以上單元循環(huán)引用時(shí)，應(yīng)該使一個(gè)程序單元在接口部分引用另一個(gè)，而且另一個(gè)則在其執(zhí)行部分引用前一個(gè)。5. 代碼縮格要求：每一層嵌套內(nèi)應(yīng)向后縮格2個(gè)字符開始。6. 每一對(duì)的beginend 都應(yīng)該在相同的縮格位置上一一對(duì)應(yīng)。7. 通用模塊要求：在單元頭的中應(yīng)包含通用模

4、塊說明、輸入?yún)?shù)及類型、8. 建立公用模塊來定義自己的全局變量、過程和函數(shù)，以及數(shù)據(jù)庫構(gòu)件等。9. 應(yīng)建立資源的概念，把用戶看到的文字、消息（CAPTION、MESSAGE）等作為資源來看待，編成資源文件讓多個(gè)應(yīng)用程序共享，在程序中這些資源均用代碼替代，做到整個(gè)系統(tǒng)的一致。10. 當(dāng)代碼版本確定后，修改別人的代碼或自己已經(jīng)完成并提交過的代碼時(shí)，必須保留被修改的代碼，并在修改和內(nèi)容前后加注：= yyyy/mm/dd xxx修改 原因：y =和= yyyy/mm/dd 修改結(jié)束 =之類的標(biāo)識(shí)（可以英文）。二、變量命名規(guī)則變量的規(guī)范命名是增強(qiáng)程序可讀性的重要舉措之一。要力求做到在程序代碼中能一眼看出

5、一個(gè)變量的可見度以及其數(shù)據(jù)類型。在所有的程序中使用統(tǒng)一的規(guī)則對(duì)變量進(jìn)行命名，這對(duì)于日后的修改和維護(hù)或是項(xiàng)目移交都是非常有益的。變量命名的規(guī)則也是<前綴> + <表意>。變量的命名主要是針對(duì)變量的可見度和變量類型進(jìn)行安裝前綴以示其屬性, 前綴除“結(jié)構(gòu)類型”和“類類型”用三個(gè)字母外其余用一個(gè)字母表示。l 可見度前綴通常，我們只需區(qū)分局部變量和全局變量就行了。缺?。o前綴）情況下為本地變量全局變量前綴為g_。l 類型前綴1. 簡(jiǎn)單類型（Simple types）序數(shù)類型（Ordinal type） 字符類型（Char type） 枚舉類型（Enumerated type） 子

6、界類型（Sub range type）2.3. 結(jié)構(gòu)類型（Structured types） 數(shù)組類型（Array type） 集合類型（Set type） 文件類型（File type）4. 5. 類類型（Class types）注：在開發(fā)中所有用到的變量均要以本規(guī)則嚴(yán)格地進(jìn)行命名。在程序代碼中申明變量的位置將在程序風(fēng)格規(guī)范一節(jié)中闡述。變量的表義部份，一般用英文表示。表義的英文可以是一個(gè)單詞或多個(gè)，每個(gè)單詞的第一個(gè)字母都要大寫。三、String資源及常量定義和使用規(guī)范一、 定義資源String單元定義一個(gè)公用的資源文件（UYResource.pas）在Project的所有Unit中Uses。

7、在該文件中用ResourceString關(guān)鍵字來定義String資源，文件格式如下：unit UYResource;interfaceresourcestringMSG_OPENFILE = 打開文件 %S 出錯(cuò);string2 = ;implementationend.二、 資源String命名規(guī)范資源String按其用處不同分為：消息資源、界面文字資源兩大類。消息資源按其提示的信息不同分為：停止信息、感嘆信息、詢問信息、提示信息等四種。命名規(guī)范如下：1消息資源：以“MSG_”為前綴，加消息內(nèi)容英文簡(jiǎn)稱2界面元素資源：以“CAP_”為前綴，加消息內(nèi)容英文簡(jiǎn)稱3常量：以“CON_”為前綴，加消

8、息內(nèi)容英文簡(jiǎn)稱4各模塊盡量使用已定義的字符串資源，如果需要新增字符串資源，以各模塊ID為后綴三、 資源String賦值及調(diào)用方法給資源String賦值時(shí)可以根據(jù)需要在其值中加下參數(shù)，如上述：MSG_OPENFILE_STP = 打開文件 %S 出錯(cuò)，其中“%S”參數(shù)是用來傳遞文件名信息的。加入的參數(shù)可以有多個(gè)，也可以有多種類型，參數(shù)以“%”打頭，后跟參數(shù)類型，參數(shù)類型說明如下：符號(hào)duefgnmpsx 類型 接受整型的參數(shù) 接受無符號(hào)的整型參數(shù) 接受科學(xué)計(jì)數(shù)法型參數(shù) 接受固定格式的參數(shù) 接受浮點(diǎn)型的參數(shù) 接受浮點(diǎn)型的參數(shù) 接受貨幣型的參數(shù) 接受指針型的參數(shù) 接受字符型的參數(shù) 接受十六進(jìn)制型的參數(shù) 調(diào)用方法 用Format函數(shù)來調(diào)用（參見Delphi Format function的Help）。 如上述：MSG_OPENFILE_STP = 打開文件 %S 出錯(cuò) 調(diào)用實(shí)例如下：ShowMessa