DQJHL-SPI-E-TS-T09(代碼走查表)

1、項(xiàng)目名稱：過(guò)程改進(jìn)-過(guò)程定義-技術(shù)解決文檔名稱：代碼走查單文件狀態(tài)：文件標(biāo)識(shí)： DQJHL-SPI-E-TS-T09 草稿當(dāng)前版本： 1.0 正式發(fā)布作 者：孟吉文 正在修改完成日期： 2009-01-20版本歷史序號(hào)版本/狀態(tài)作者完成日期變更內(nèi)容描述011.0孟吉文2009/1/20建立說(shuō)明:本頁(yè)僅用于模板的管理,對(duì)于實(shí)際使用時(shí),應(yīng)不包括本頁(yè)的內(nèi)容程序結(jié)構(gòu)清晰，簡(jiǎn)單易懂，單個(gè)函數(shù)行數(shù)不得超過(guò)100行；精簡(jiǎn)代碼，避免垃圾程序；盡量使用標(biāo)準(zhǔn)庫(kù)函數(shù)和公共函數(shù)。不允許隨意定義全局變量。一個(gè)變量只能有一個(gè)用途；變量的用途必須和變量的名稱保持一致。所有變量都必須在類和函數(shù)最前面定義，并分類排列。查找數(shù)據(jù)

2、庫(kù)表或視圖時(shí)，只能取出確實(shí)需要的那些字段。使用無(wú)關(guān)子查詢，而不要使用關(guān)聯(lián)子查詢。清楚明白地使用列名，而不能使用列的序號(hào)。盡可能晚地創(chuàng)建對(duì)象，并且盡可能早地釋放它不允許隨意定義公用的函數(shù)。函數(shù)功能單一，不允許一個(gè)函數(shù)實(shí)現(xiàn)兩個(gè)及兩個(gè)以上的功能。不能在函數(shù)內(nèi)部使用全局變量，如要使用全局變量，應(yīng)轉(zhuǎn)化為局部變量。函數(shù)與函數(shù)之間只允許存在包含關(guān)系，不允許存在交叉關(guān)系。盡量使用標(biāo)準(zhǔn)英文單詞，也可以使用中文拼音（縮寫(xiě)），不允許英文單詞和拼音混寫(xiě)。 使用大小寫(xiě)混合格式，將連接的幾個(gè)單詞首字母大寫(xiě)。必須在3至30個(gè)字母以內(nèi)。如果使用縮寫(xiě)，必須使用本規(guī)范附錄的縮寫(xiě)范例。文件命名采用主謂結(jié)構(gòu)，首字母大寫(xiě)。文件和文件夾

3、的名稱應(yīng)該精確地說(shuō)明它們的用途。函數(shù)名和方法名以動(dòng)賓結(jié)構(gòu)，首字母大寫(xiě)在命名函數(shù)時(shí)包括返回值的說(shuō)明類名和屬性名以名詞開(kāi)始，首字母大寫(xiě)在不同的類中的屬性，如果它們有相同的作用，則必須使用同樣的名稱。所有變量都必須有前綴，使用24個(gè)字母，全部小寫(xiě)。避免與函數(shù)名、方法名、類名和屬性名相同。避免使變量名為另一個(gè)變量名的一部分。布爾變量名應(yīng)該包含 Is，如 blnFileIsFound。常量所有字母都應(yīng)該大寫(xiě)，單詞之間用下劃線連接見(jiàn)規(guī)范2.1見(jiàn)規(guī)范2.2見(jiàn)規(guī)范2.3見(jiàn)規(guī)范2.5-3 見(jiàn)規(guī)范2.5-4見(jiàn)規(guī)范2.5-5見(jiàn)規(guī)范2.5-6對(duì)象命名、中文說(shuō)明、快捷鍵1、注釋必須使用中文及中文的標(biāo)點(diǎn)符號(hào)。2、每行注釋

4、的最大長(zhǎng)度為100個(gè)字符。3、將注釋與注釋分隔符用一個(gè)空格分開(kāi)。4、不允許給注釋加外框。5、編碼的同時(shí)書(shū)寫(xiě)注釋。6、重要變量必須有注釋。7、變量注釋和變量在同一行，所有注釋必須對(duì)齊，與變量分開(kāi)至少兩個(gè)Tab鍵。8、典型算法必須有注釋。9、在循環(huán)和邏輯分支的地方必須寫(xiě)上注釋。10、程序段或語(yǔ)句的注釋在程序段或語(yǔ)句的上一行。11、在代碼交付之前，必須刪掉臨時(shí)的或無(wú)關(guān)的注釋。12、注釋行數(shù)（不包括程序頭和函數(shù)頭說(shuō)明部分）應(yīng)占總行數(shù)的1/51/3。事件和函數(shù)的頭部都必須有概述注釋信息。事件和函數(shù)的概述注釋?xiě)?yīng)縮進(jìn)1個(gè)空格。事件和函數(shù)注釋內(nèi)容的格式和完整性。每一個(gè)相應(yīng)獨(dú)立的程序段都要標(biāo)明注釋，并且與上一程

5、序段空一行；所有的新建對(duì)象都要有相應(yīng)的說(shuō)明，修改對(duì)象時(shí)需要作簡(jiǎn)要描述。在操作符的前后必須使用空格。在分隔數(shù)組下標(biāo)和函數(shù)參數(shù)的逗號(hào)后面必須添上空格。一個(gè)程序段上下必須使用空行。變量定義部分與程序語(yǔ)句之間必須使用空行。利用縮進(jìn)來(lái)顯示程序的邏輯結(jié)構(gòu)，縮進(jìn)量一致并以Tab鍵為單位，定義Tab鍵為4個(gè)空格字符。條件、循環(huán)語(yǔ)句的保留字使用縮進(jìn)寫(xiě)SQL語(yǔ)句時(shí)，關(guān)鍵字必須使用大寫(xiě)。 把每個(gè)SQL子語(yǔ)句分開(kāi)放在不同的行中。系統(tǒng)提供的事件、函數(shù)、關(guān)鍵字，大小寫(xiě)按系統(tǒng)規(guī)范來(lái)寫(xiě)。自定義的事件、函數(shù)統(tǒng)一小寫(xiě)。PB中的保留字首字大寫(xiě)，相應(yīng)位置有3個(gè)空格的縮進(jìn)。不允許使用純粹的不帶語(yǔ)意的數(shù)字或字符串，而應(yīng)該使用定義過(guò)的常量

6、。通常界面設(shè)計(jì)都按Windows界面的規(guī)范來(lái)設(shè)計(jì)，即包含“菜單條、工具欄、工具廂、狀態(tài)欄、滾動(dòng)條、右鍵快捷菜單”的標(biāo)準(zhǔn)格式。規(guī)范性細(xì)則：1）常用菜單要有命令快捷方式。2）完成相同或相近功能的菜單用橫線隔開(kāi)放在同一位置。3）菜單前的圖標(biāo)能直觀的代表要完成的操作。4）菜單深度一般要求最多控制在三層以內(nèi)。5）工具欄要求可以根據(jù)用戶的要求自己選擇定制。6）相同或相近功能的工具欄放在一起。7) 工具欄中的每一個(gè)按鈕要有及時(shí)提示信息。8）一條工具欄的長(zhǎng)度最長(zhǎng)不能超出屏幕寬度。9）工具欄的圖標(biāo)能直觀的代表要完成的操作。10）系統(tǒng)常用的工具欄設(shè)置默認(rèn)放置位置。11）工具欄太多時(shí)可以考慮使用工具廂。12）工具廂

7、要具有可增減性，由用戶自己根據(jù)需求定制。13）工具廂的默認(rèn)總寬度不要超過(guò)屏幕寬度的1/5。14）狀態(tài)條要能顯示用戶切實(shí)需要的信息，常用的有：目前的操作、系統(tǒng)狀態(tài)、用戶位置、用戶信息、提示信息、錯(cuò)誤信息等，如果某一操作需要的時(shí)間較長(zhǎng)，還應(yīng)該顯示進(jìn)度條和進(jìn)程提示。15）滾動(dòng)條的長(zhǎng)度要根據(jù)顯示信息的長(zhǎng)度或?qū)挾饶芗皶r(shí)變換，以利于用戶了解顯示信息的位置和百分比。16）狀態(tài)條的高度以放置五號(hào)字為宜，滾動(dòng)條的寬度比狀態(tài)條的略窄。17）菜單和工具條要有清楚的界限；菜單要求凸出顯示，這樣在移走工具條時(shí)仍有立體感。18）菜單和狀態(tài)條中通常使用5號(hào)字體。19）工具條一般比菜單要寬，但不要寬的太多，否則看起來(lái)很不協(xié)調(diào)

8、。20）右鍵快捷菜單采用與菜單相同的準(zhǔn)則。窗口標(biāo)題統(tǒng)一取系統(tǒng)變量gnv_app.MSGTITLE。提示信息中的標(biāo)點(diǎn)符號(hào)全部采用中文標(biāo)點(diǎn)字符。工具欄保留必須通用按鈕，并且根據(jù)功能控制是否可用。新增按鈕必須排列在通用按鈕之后，退出按鈕之前。新增按鈕必須有MDI幫助和說(shuō)明。數(shù)據(jù)窗口（DataWindow）數(shù)據(jù)窗的行高68、單元格高度為56，行線顏色border(none)、背景白色（white）；列表式數(shù)據(jù)窗一般為Grid，數(shù)據(jù)窗的字體“宋體 9”，數(shù)據(jù)窗Header高68、標(biāo)簽（Text）高56，背景為灰色（ButtonFace），平面（No border）按鈕（CommandButton）按鈕的

9、大小 長(zhǎng)度：334，高度：88其他控件StaticText、SinglelineEdit、EditMask的高度為72全部采用默認(rèn)樣式（3D），以統(tǒng)一界面為標(biāo)準(zhǔn)。長(zhǎng)寬比例要求一致，建議采用黃金比例法彈出的層數(shù)不能超過(guò)3個(gè)，并且保證是響應(yīng)式窗口同類型的窗口保持布局一致見(jiàn)五、金舟界面規(guī)范第7點(diǎn)5代代碼碼走走查查單單項(xiàng)目名稱制 表 人編碼人編碼時(shí)間模塊代碼模塊名稱實(shí)際提交日期測(cè)試完成日期代代碼碼走走查查代代碼碼規(guī)規(guī)范范程序結(jié)構(gòu)清晰，簡(jiǎn)單易懂，單個(gè)函數(shù)行數(shù)不得超過(guò)100行；精簡(jiǎn)代碼，避免垃圾程序；盡量使用標(biāo)準(zhǔn)庫(kù)函數(shù)和公共函數(shù)。不允許隨意定義全局變量。一個(gè)變量只能有一個(gè)用途；變量的用途必須和變量的名稱保

10、持一致。所有變量都必須在類和函數(shù)最前面定義，并分類排列。查找數(shù)據(jù)庫(kù)表或視圖時(shí)，只能取出確實(shí)需要的那些字段。使用無(wú)關(guān)子查詢，而不要使用關(guān)聯(lián)子查詢。清楚明白地使用列名，而不能使用列的序號(hào)。盡可能晚地創(chuàng)建對(duì)象，并且盡可能早地釋放它不允許隨意定義公用的函數(shù)。函數(shù)功能單一，不允許一個(gè)函數(shù)實(shí)現(xiàn)兩個(gè)及兩個(gè)以上的功能。不能在函數(shù)內(nèi)部使用全局變量，如要使用全局變量，應(yīng)轉(zhuǎn)化為局部變量。函數(shù)與函數(shù)之間只允許存在包含關(guān)系，不允許存在交叉關(guān)系。盡量使用標(biāo)準(zhǔn)英文單詞或使用中文拼音（縮寫(xiě)），不允許英文單詞和拼音混寫(xiě)。 使用大小寫(xiě)混合格式，將連接的幾個(gè)單詞首字母大寫(xiě)。變量長(zhǎng)度必須在3至30個(gè)字母以內(nèi)。如果使用縮寫(xiě)，必須使用本

11、規(guī)范附錄的縮寫(xiě)范例。文件命名采用主謂結(jié)構(gòu)，首字母大寫(xiě)。函數(shù)名和方法名以動(dòng)賓結(jié)構(gòu)，首字母大寫(xiě)在命名函數(shù)時(shí)包括返回值的說(shuō)明類名和屬性名以名詞開(kāi)始，首字母大寫(xiě)在不同的類中的屬性，如果它們有相同的作用，則必須使用同樣的名稱。所有變量都必須有前綴，使用24個(gè)字母，全部小寫(xiě)。避免與函數(shù)名、方法名、類名和屬性名相同。避免使變量名為另一個(gè)變量名的一部分。布爾變量名應(yīng)該包含 Is，如 blnFileIsFound。常量所有字母都應(yīng)該大寫(xiě)，單詞之間用下劃線連接在操作符的前后必須使用空格。在分隔數(shù)組下標(biāo)和函數(shù)參數(shù)的逗號(hào)后面必須添上空格。一個(gè)程序段上下必須使用空行。變量定義部分與程序語(yǔ)句之間必須使用空行。利用縮進(jìn)來(lái)顯

12、示程序的邏輯結(jié)構(gòu)，縮進(jìn)量一致并以Tab鍵為單位，Tab鍵為4個(gè)空格。條件、循環(huán)語(yǔ)句的保留字使用縮進(jìn)寫(xiě)SQL語(yǔ)句時(shí)，關(guān)鍵字必須使用大寫(xiě)。 把每個(gè)SQL子語(yǔ)句分開(kāi)放在不同的行中。系統(tǒng)提供的事件、函數(shù)、關(guān)鍵字，大小寫(xiě)按系統(tǒng)規(guī)范來(lái)寫(xiě)。6自定義的事件、函數(shù)統(tǒng)一小寫(xiě)。PB中的保留字首字大寫(xiě)，相應(yīng)位置有3個(gè)空格的縮進(jìn)。不允許使用純粹的不帶語(yǔ)意的數(shù)字或字符串，而應(yīng)該使用定義過(guò)的常量。注注釋釋規(guī)規(guī)范范注釋必須使用中文及中文的標(biāo)點(diǎn)符號(hào)。每行注釋的最大長(zhǎng)度為100個(gè)字符。將注釋與注釋分隔符用一個(gè)空格分開(kāi)。不允許給注釋加外框。編碼的同時(shí)書(shū)寫(xiě)注釋。重要變量必須有注釋。變量注釋和變量在同一行，所有注釋必須對(duì)齊，與變量分開(kāi)

13、至少兩個(gè)Tab鍵。典型算法必須有注釋。在循環(huán)和邏輯分支的地方必須寫(xiě)上注釋。程序段或語(yǔ)句的注釋在程序段或語(yǔ)句的上一行。在代碼交付之前，必須刪掉臨時(shí)的或無(wú)關(guān)的注釋。注釋行數(shù)（不包括程序頭和函數(shù)頭說(shuō)明部分）應(yīng)占總行數(shù)的1/51/3。事件和函數(shù)的頭部都必須有概述注釋信息。事件和函數(shù)的概述注釋?xiě)?yīng)縮進(jìn)1個(gè)空格。事件和函數(shù)注釋內(nèi)容的格式和完整性。每一個(gè)相應(yīng)獨(dú)立的程序段都要標(biāo)明注釋，并且與上一程序段空一行；所有的新建對(duì)象都要有相應(yīng)的說(shuō)明，修改對(duì)象時(shí)需要作簡(jiǎn)要描述。界界面面規(guī)規(guī)范范常用菜單要有命令快捷方式。完成相同或相近功能的菜單用橫線隔開(kāi)放在同一位置。菜單前的圖標(biāo)能直觀的代表要完成的操作。菜單深度一般要求最多

14、控制在三層以內(nèi)。工具欄要求可以根據(jù)用戶的要求自己選擇定制。相同或相近功能的工具欄放在一起。工具欄中的每一個(gè)按鈕要有及時(shí)提示信息。一條工具欄的長(zhǎng)度最長(zhǎng)不能超出屏幕寬度。工具欄的圖標(biāo)能直觀的代表要完成的操作。系統(tǒng)常用的工具欄設(shè)置默認(rèn)放置位置。工具廂要具有可增減性，由用戶自己根據(jù)需求定制。工具廂的默認(rèn)總寬度不要超過(guò)屏幕寬度的1/5。狀態(tài)條要能顯示用戶切實(shí)需要的信息，常用的有：目前的操作、系統(tǒng)狀態(tài)、用戶位置、用戶信息、提示信息、錯(cuò)誤信息等，如果某一操作需要的時(shí)間較長(zhǎng)，還應(yīng)該顯示進(jìn)度條和進(jìn)程提示。滾動(dòng)條的長(zhǎng)度要根據(jù)顯示信息的長(zhǎng)度或?qū)挾饶芗皶r(shí)變換，以利于用戶了解顯示信息的位置和百分比。狀態(tài)條的高度以放置五

15、號(hào)字為宜，滾動(dòng)條的寬度比狀態(tài)條的略窄。菜單和工具條要有清楚的界限；菜單要求凸出顯示。菜單和狀態(tài)條中通常使用5號(hào)字體。工具條一般比菜單要寬，但不要寬的太多，否則看起來(lái)很不協(xié)調(diào)。右鍵快捷菜單采用與菜單相同的準(zhǔn)則。窗口標(biāo)題統(tǒng)一取系統(tǒng)變量gnv_app.MSGTITLE。提示信息中的標(biāo)點(diǎn)符號(hào)全部采用中文標(biāo)點(diǎn)字符。工具欄保留必須通用按鈕，并且根據(jù)功能控制是否可用。新增按鈕必須排列在通用按鈕之后，退出按鈕之前。新增按鈕必須有MDI幫助和說(shuō)明。數(shù)據(jù)窗的行高68、單元格高度為56，行線顏色border(none)、背景白色（white）；7列表式數(shù)據(jù)窗一般為Grid，數(shù)據(jù)窗的字體“宋體 9”，數(shù)據(jù)窗Heade

16、r高68、標(biāo)簽（Text）高56，背景為灰色（ButtonFace），平面（No border）按鈕（CommandButton）按鈕的大小 長(zhǎng)度：334，高度：88其他控件StaticText、SinglelineEdit、EditMask的高度為72全部采用默認(rèn)樣式（3D），以統(tǒng)一界面為標(biāo)準(zhǔn)。長(zhǎng)寬比例要求一致，建議采用黃金比例法彈出的層數(shù)不能超過(guò)3個(gè)，并且保證是響應(yīng)式窗口同類型的窗口保持布局一致代碼走查人簽字：QA人員簽字：8文件編碼DQJHL-SPI-E-TS-T09制表時(shí)間 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合

17、 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合

18、 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 代代碼碼走走查查代代碼碼規(guī)規(guī)范范9 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合 不符合 基本符合 符合