ＶＢ編碼規(guī)則技術(shù)文件資料.doc

NETS編碼規(guī)則株式會(huì)社東芝（注）：頁(yè)開(kāi)始是英文文資料。NOTE :The prvious page is the Japanese Documentations . The English ones Starts from this page .資料號(hào)碼：.第 1 章 序言4第 2 章 編碼的準(zhǔn)備5第 3章 命名規(guī)約63 1 . 使用的目的63 2 . Object的結(jié)構(gòu)化733. 前綴（prefix）83 4 . 標(biāo)簽（tag）93 5 . 基本名（BaseName）103 6 . 量詞（ Qualifier）113 7 . 后綴（Suffix）12第章模塊頭134 1 . 外部模塊頭134 2 . 內(nèi)部模塊頭154 3 . 注釋語(yǔ)句17第 5章 錯(cuò)誤處理195 1 . 結(jié)構(gòu)化錯(cuò)誤處理195 2 . Inline錯(cuò)誤處理19第 6章 編碼規(guī)約206 1 . 函數(shù)化206 2 . 常數(shù)的使用206 3 . 變量的聲明206 3 1 . 變量生明206 3 2 . 變量的范圍226 4 . 函數(shù)的聲明226 4 1.SUB226 4 2 . FUNC226 5 . 控制語(yǔ)句226 5 1 . I FENDIF225 5 2. FORNEXT245 5 3.SELECTCASE255 5 4.DO LOOP27第 7 章 控件28第章用戶控件29.在用戶控件上作成規(guī)定屬性298 2 . 在用戶控件中作成規(guī)定Event30第章數(shù)據(jù)庫(kù)訪問(wèn)規(guī)則31開(kāi)發(fā)環(huán)境31連接斷開(kāi)31表示檢索的結(jié)果33第 1 章 序言所謂編碼就是基于在程序設(shè)計(jì)時(shí)作成的程序設(shè)計(jì)書(shū)和流程圖等邏輯設(shè)計(jì)、用編程語(yǔ)言、對(duì)為在計(jì)算機(jī)上實(shí)現(xiàn)某些功能的邏輯進(jìn)行描述的工作。在編碼過(guò)程中、為了消除因程序員水平不同而造成的差異、為了順利的進(jìn)入單體測(cè)試階段、同時(shí)也為了維護(hù)方便、以下整理了編碼的準(zhǔn)備和代碼書(shū)寫的標(biāo)準(zhǔn)。而且、關(guān)于書(shū)寫標(biāo)準(zhǔn)、除非客戶有指定的要求、或者使用了（半）自動(dòng)生成代碼的工具話、則應(yīng)盡量遵從這個(gè)標(biāo)準(zhǔn)。本規(guī)范是以使用Microsoft 的 Visual Basic 來(lái)開(kāi)發(fā)PC的應(yīng)用程序?yàn)榍疤岬摹５?2 章 編碼的準(zhǔn)備（1） 以系統(tǒng)設(shè)計(jì)書(shū)、程序設(shè)計(jì)書(shū)（根據(jù)情況也包含流程圖等的邏輯設(shè)計(jì)書(shū)）為基礎(chǔ)。（2） 在完全理解了以上文檔內(nèi)容的基礎(chǔ)上開(kāi)始編碼工作（特別是程序設(shè)計(jì)書(shū)的作者和編碼的擔(dān)當(dāng)者不同時(shí)）。對(duì)于不明白的地方不要隨意判斷、要進(jìn)行確認(rèn)。（3） 始終注意要把程序的易理解性（易讀性）放在第一位。為此、在編程時(shí)要時(shí)刻想著程序的讀者、本著以向讀者說(shuō)明的態(tài)度來(lái)編寫程序是寫好程序的關(guān)鍵。讀起來(lái)容易理解的程序一般來(lái)說(shuō)總是質(zhì)量?jī)?yōu)良、而且容易改造的。（4） 象數(shù)據(jù)庫(kù)的記錄的規(guī)范等include文件、模塊頭、宏定義等系統(tǒng)應(yīng)該統(tǒng)一的東西、要采用系統(tǒng)規(guī)定的東西、不要根據(jù)個(gè)人的意愿隨意的作成、否則、這將成為在進(jìn)行變更和改造時(shí)發(fā)生問(wèn)題的原因。（5） 編碼結(jié)束后、要對(duì)代碼進(jìn)行檢查。不檢查代碼則不能輕易的進(jìn)入下一步的測(cè)試階段的工作。檢查代碼不僅是最容易發(fā)現(xiàn)錯(cuò)誤的方法、而且有時(shí)還能檢出在測(cè)試時(shí)不易發(fā)現(xiàn)的復(fù)雜錯(cuò)誤。第 3章 命名規(guī)約3 1 . 使用的目的命名規(guī)約以以下4點(diǎn)為目的的而使用。（1） Object名容易明白會(huì)使應(yīng)用程序的結(jié)構(gòu)代碼等容易理解。（2） 確立開(kāi)發(fā)小組“通用語(yǔ)言”、使全體成員用同樣的“語(yǔ)言”來(lái)開(kāi)發(fā)應(yīng)用程序。（3） 使VB Jet的Object 容易被使用。（4） 用較少的勞力作成VB開(kāi)發(fā)用的工具、在各式各樣的VBA 平臺(tái)里通用的源碼庫(kù)。本規(guī)約是用遵從被VisualBasic作為標(biāo)準(zhǔn)的 Lezynski命名規(guī)則（Lezynski Naming Convention、 以下稱LNC）的方法來(lái)規(guī)定命名法的。3 2 . Object的結(jié)構(gòu)化LNC按以下格式對(duì)Object進(jìn)行命名。 Prefix tag BaseName Quantifier Suffix Prefix前綴Tag標(biāo)簽BaseName基本名Quantifier量詞Suffix后綴對(duì)各個(gè)部分按順序進(jìn)行說(shuō)明。. 前綴（prefix）前綴是在標(biāo)簽前面的識(shí)別符、是對(duì)標(biāo)簽進(jìn)行進(jìn)一步詳細(xì)說(shuō)明的。前綴用1到2個(gè)小寫字母組成。對(duì)1個(gè)Object復(fù)數(shù)個(gè)前綴可以組合使用。前綴有表示有效范圍的和表示變量特性的。另外、2個(gè)前綴能夠重疊使用。（1） 表示有效范圍的前綴表1 . 表示有效范圍的前綴無(wú)Procedure內(nèi)的局部變量s用Static聲明的Procedure的局部變量m在模塊Declarations Section 的用Dim 或Private聲明的模塊水平的變量p在模塊的Declarations Section用Public聲明的變量g在模塊的Declarations Section作為Public或Global聲明的變量（2） 表示變量特性的前綴表2. 表示變量特性的前綴a作為數(shù)組聲明的變量c用Const聲明的變量e作為的Collection1個(gè)要素的變量i作為數(shù)組的Index或循環(huán)的計(jì)數(shù)器使用的變量r傳遞給Procedure參數(shù)的作為參照傳遞( ByRef )聲明的變量t作為用戶定義型定義的變量v傳遞給Procedure參數(shù)的作為值傳遞( ByVal )聲明的變量（3） 例值傳遞的參數(shù)：vintCount參照傳遞的參數(shù)： rstrFileName在Declarations用public聲明的數(shù)組的Index變量：apintMember用Const聲明的變量：cintFNAMEMAX3 4 . 標(biāo)簽（tag）標(biāo)簽是表示基本名的特征的復(fù)數(shù)個(gè)的字母、放在基本名的前面。標(biāo)簽基本上相當(dāng)于面向Object編程的類識(shí)別符。標(biāo)簽用3到4個(gè)小寫字母組成。標(biāo)簽是表示基本名的特征的復(fù)數(shù)個(gè)的字母、表示變量的型啦的種類。從標(biāo)簽表示的意思上可以對(duì)數(shù)據(jù)型、模塊、Form、控件的標(biāo)簽進(jìn)行分類。（1） 數(shù)據(jù)型表3. 數(shù)據(jù)型標(biāo)簽布爾值bln長(zhǎng)整數(shù)lngBytebytObjectobj雙精度浮點(diǎn)數(shù)dbl字符串str錯(cuò)誤err用戶定義typ整數(shù)intVariantvar（2） 模塊、Form、控件表4 模塊標(biāo)簽 表5. 標(biāo)簽類模塊cls對(duì)話框fdlg標(biāo)準(zhǔn)模塊bas菜單fmnuFormfrm表6. 控件標(biāo)簽Command ButtoncmdOption Buttonopt控件ctlPocturepic,picsCombo BoxcboPrinterprn,prns菜單mnu屬性prp,prps菜單項(xiàng)mni,mnisTabtab,tabsNodenod,modsText BoxtxtList BoxlstCommon Dialogcdlg（3） 例l 判定成功用的變量：blnSuccessl 文件名：strFileNamel 檢索處理用的標(biāo)準(zhǔn)模塊：basSearchDatal 主Form：frmMainl Start Button：cmdStartl Font Dialog：cdlgFont3 5 . 基本名（BaseName）基本名是設(shè)Object名是最先遇到的部分、是不管采用不采用命名規(guī)則都必須使用的名字?；久糜幸饬x的單詞（原則上用英文單詞）來(lái)組合、各個(gè)單詞的第一個(gè)字母大寫其余用小寫。這時(shí)、再加上專用名詞的情況下、要用日語(yǔ)的羅馬字。但是、用Const聲明的變量的基本名全部用大寫。另外、雖然沒(méi)有限制、基本名還是要選擇不太長(zhǎng)的名字。作為基本名的樣本用在VB編碼里的標(biāo)準(zhǔn)的作業(yè)變量表示如下。表7 . 標(biāo)準(zhǔn)LNC作業(yè)變量blnRET接受函數(shù)調(diào)用的返回值（ True/False ）intErr保持Err的值intLoop循環(huán)計(jì)數(shù)器intMsg接受MsgBox函數(shù)的返回值intResult保持算術(shù)演算的接果（dblresult 、lngResult 也同樣）intRet接受函數(shù)調(diào)用的返回值（dblRet、lngRet也同樣）intWord用在所有暫時(shí)的作業(yè)（dblWord 、 lngWork也同樣）strMsg作成Message Box字符串3 6 . 量詞（ Qualifier）量詞表示Object在關(guān)聯(lián)上是怎樣被利用的。（最大、最小等）量詞要盡量短、用大寫.小寫字母的組合來(lái)表示。表8 . 量詞Curr存貯1Set內(nèi)的現(xiàn)在的要素First存貯1Set內(nèi)的最初的要素Hold存貯以后要使用的要素Last存貯1Set內(nèi)的最后的要素Max存貯1Set內(nèi)的最大要素Min存貯1Set內(nèi)的最小要素Next存貯1Set內(nèi)的下一個(gè)的要素New存貯的新的instance或值Oid存貯的以前的instance或值Prev存貯1Set內(nèi)的前面的要素Src存貯SourceTemp存貯暫時(shí)的值3 7 . 后綴（Suffix）后綴是以在按照命名規(guī)則時(shí)變成的名字的Object名上識(shí)別符為目的而添加的。所以不是非要不可、根據(jù)Project決定是否采用。假設(shè)DB關(guān)聯(lián)的標(biāo)準(zhǔn)模塊有SortData、DeleteData、InsertData、UpdateData4個(gè)。這時(shí)、如果存貯錯(cuò)誤碼的變量設(shè)為、在各個(gè)模塊里確保變量的話、就會(huì)區(qū)別不開(kāi)。如果在取各個(gè)模塊的大寫的2個(gè)字母作后綴、各個(gè)變量就能區(qū)別開(kāi)。SortData（ SD ）-gintErr_SDDeleteData（ DD ）-gintErr_DDDeleteData（ ID ）-gintErr_IDDeleteData（ UD ）-gintErr_UD雖然后綴的決定方法沒(méi)有特別的基準(zhǔn)、還是要選擇容易明白區(qū)別基準(zhǔn)的2到3個(gè)字母的字符串。另外、大寫字母、小寫字母可以任意使用。第章模塊頭 模塊頭對(duì)了解模塊的概要是很有效的、另外還有助于維護(hù)。所以、對(duì)此必須記述。4 1 . 外部模塊頭外部模塊頭要記述以下項(xiàng)目。（有關(guān)程序全體的信息在Include文件（文件名=程序名.h）記述。）（ a ）模塊識(shí)別信息 系統(tǒng)名 客戶名 程序名或模塊名 擔(dān)當(dāng)部科名 著作權(quán)表示（ b ） 模塊說(shuō)明 功能 參數(shù)說(shuō)明 動(dòng)作環(huán)境/作成環(huán)境 作成擔(dān)當(dāng)著名（ c ） 履歷 作成日時(shí)（單體試驗(yàn)完成日） 變更日時(shí) 變更內(nèi)容 版本信息（ d ）補(bǔ)充說(shuō)明 外部模塊頭*Copyright Shenyang NETS System Integration Co. Ltd.1998.All Rights Reserved.系統(tǒng)名 ：系統(tǒng)名客戶 ：客戶 程序 ：程序名稱擔(dān)當(dāng)部長(zhǎng) ：沈陽(yáng)東東系統(tǒng)集成有限公司 開(kāi)發(fā)一部*功能 ：功能概要參數(shù) ：對(duì)有關(guān)重要參數(shù)進(jìn)行說(shuō)明作成環(huán)境 ：工具、編譯環(huán)境、OS動(dòng)作環(huán)境 ：OS、制約條件擔(dān)當(dāng) ：擔(dān)當(dāng)者名作成日 ：1999年5月28日 （Ver.0）*變更履歷 Ver.0.1 1999年5月28日 所屬 擔(dān)當(dāng)者名 變更理由 變更內(nèi)容Ver.1.0 1999年6月15日 所屬 擔(dān)當(dāng)者名 變更理由 變更內(nèi)容*/4 2 . 內(nèi)部模塊頭在內(nèi)部模塊頭寫下以下項(xiàng)目。 （ a ）模塊說(shuō)明 功能 參數(shù)說(shuō)明 動(dòng)作環(huán)境/作成環(huán)境 作成擔(dān)當(dāng)者名 （ b ）履歷 作成日時(shí)（單體試驗(yàn)完成日） 變更日時(shí) 變更內(nèi)容 版本信息（c ）補(bǔ)充說(shuō)明 內(nèi)部模塊頭*功能 ：功能概要參數(shù) ：對(duì)有關(guān)參數(shù)進(jìn)行說(shuō)明擔(dān)當(dāng) ：擔(dān)當(dāng)者名作成日 ：1999年5月28日（Ver .0）*變更履歷Ver .0 1999年5月31日 所屬 擔(dān)當(dāng)者名 變更理由. 變更內(nèi)容Ver .0 1999年6月15日 所屬 擔(dān)當(dāng)者名 變更理由. 變更內(nèi)容*4 3 . 注釋語(yǔ)句1. 考慮到提高維護(hù)性、以模塊及塊為單位寫上內(nèi)容說(shuō)明、以便馬上能找到修改的地方。2. 為了幫助讀者理解程序、在不容易理解的邏輯上加上說(shuō)明。不是在只讀了程序馬上就能理解的地方加上注釋、而是要象給讀者提供新信息之類的說(shuō)明。例如、寫上在那里使用的算法的注釋。3. 不要加上不必要的注釋。在注釋之前、先要在識(shí)別符命名法、整理程序構(gòu)造上下工夫使程序容易被讀懂。4. 注釋語(yǔ)句盡可能寫的簡(jiǎn)單明了.5. 注釋寫在語(yǔ)句的前面時(shí)要和語(yǔ)句的列對(duì)齊。 注釋 XXXX YYYY6. 把源碼刪除、改成注釋時(shí)、不要用不容易弄清范圍是否有效的寫法。 Ver0.5 刪除 start XXXXX； YYYYY； Ver0.5 刪除 end. 變更 修改程序時(shí)對(duì)注釋也必須進(jìn)行維護(hù)。第 5章 錯(cuò)誤處理錯(cuò)誤處理有“結(jié)構(gòu)化錯(cuò)誤處理”和“Inline錯(cuò)誤處理”2種方法?，F(xiàn)在的主流雖然是“結(jié)構(gòu)化錯(cuò)誤處理”、根據(jù)系統(tǒng)也可以使用“Inline錯(cuò)誤處理”。另外、也可以把兩個(gè)組合起來(lái)使用。但是、必須對(duì)所有的錯(cuò)誤的發(fā)生都執(zhí)行錯(cuò)誤處理來(lái)進(jìn)行編碼。5 1 . 結(jié)構(gòu)化錯(cuò)誤處理結(jié)構(gòu)化錯(cuò)誤處理是以“On Error Goto XXXX”的語(yǔ)句來(lái)記述、在XXXX的部分記述錯(cuò)誤處理的方法。這時(shí)、錯(cuò)誤處理程序XXXX原則上寫在Procedure的最后、XXXX要設(shè)成、“錯(cuò)誤名”+“Err”的名字。5 2 . Inline錯(cuò)誤處理Inline錯(cuò)誤處理是在錯(cuò)誤發(fā)生后馬上Trap錯(cuò)誤的編碼方法。為了實(shí)行這個(gè)、實(shí)施以下2點(diǎn)。 在Procedure的開(kāi)始處寫上“On Error Resume Next”語(yǔ)句 在有可能發(fā)生錯(cuò)誤的碼的緊后面編進(jìn)確認(rèn)邏輯。第 6章 編碼規(guī)約6 1 . 函數(shù)化 在符合以下條件的情況下、要把處理匯總成子成序。 2個(gè)地方以上被使用的處理 超過(guò)100步的處理獨(dú)自作成的函數(shù)要寫在BAS文件里。這時(shí)、BAS文件的最大步數(shù)不要超過(guò)500步。關(guān)于被2個(gè)以上可執(zhí)行文件使用的函數(shù)、共享包含那個(gè)函數(shù)的BAS文件。6 2 . 常數(shù)的使用關(guān)于字符串的尺寸、上限值、下限值等預(yù)先定下來(lái)的值、要把這個(gè)作為文字常數(shù)來(lái)定義并使用此常數(shù)。6 3 . 變量的聲明 6 3 1 . 變量聲明（ 1 ）“Option Explicit”生明Option Explicit”聲明使聲明所有的變量在參照前必須進(jìn)行聲明的聲明。在作成新模塊時(shí)、必須進(jìn)行這個(gè)聲明?；蛟诃h(huán)境中設(shè)置。（ 2 ） “Dim”聲明Dim”聲明是為了聲明變量并分配存貯領(lǐng)域而使用。因?yàn)槁暶饕蛏鞯牡胤讲煌狗秶煌⑺匀绻Ｍ秶鞔_的話、用“Public”、“Private”聲明進(jìn)行聲明。用“Dim”聲明進(jìn)行變量聲明時(shí)、必須把變量的型用“As Type ”來(lái)聲明這時(shí)、在進(jìn)行復(fù)數(shù)個(gè)變量聲明的情況下、要給各個(gè)變量加上“As Type”。例）Dim strName As String , strFile As String ,strData As String 這種情況下、String型的str Name str File, str Data 3個(gè)變量被生明。Dim strName , strFile ,strData As String 這種情況下、Variant型的s z Name 、s z File 和String 型的s z Data 變量被聲明。 （ 3 ）“Public 、Private”聲明這些聲明是在對(duì)水平的變量進(jìn)行聲明時(shí)使用?！癙ublic”是對(duì)Project內(nèi)通用的變量、“Private”是只對(duì)模塊內(nèi)使用的變量使用。（ 4 ）“Static” 聲明在對(duì)Procedure水平的變量進(jìn)行聲明時(shí)使用。用“Static”聲明的變量在程序執(zhí)行期間內(nèi)成為有效的變量。（ 5 ）“Const”聲明 Procedure模塊兩方多可使用。用“Const”聲明的變量不能變更。用“Public” “ Static” “ Const”聲明的變量要預(yù)先記載在設(shè)計(jì)書(shū)上。另外、盡可能地把這些變量匯總在1個(gè)標(biāo)準(zhǔn)模塊上聲明。6 3 2 . 變量的范圍變量由于聲明的地方和聲明的種類不同有效范圍會(huì)有所不同、所以要在考慮范圍后再對(duì)變量進(jìn)行聲明。6 4 . 函數(shù)及子程序的聲明函數(shù)的聲明參數(shù)“ByRef” “ByVal”的聲明必須進(jìn)行。讀入在DLL定義的函數(shù)時(shí)、要對(duì)被DLL Export的函數(shù)名確認(rèn)后在進(jìn)行聲明。用Alias變更函數(shù)名時(shí)、要用容易明白原來(lái)的函數(shù)名的名字。6 4 1.SUB調(diào)用子程序時(shí)、有用和不用Call調(diào)用的方法、在系統(tǒng)中要統(tǒng)一。6 4 2 . FUNC 聲明函數(shù)時(shí)、要用As Type的形式對(duì)返回值進(jìn)行聲明。6 5 . 控制語(yǔ)句6 5 1 . I FENDIF有關(guān)條件比較、必須考慮進(jìn)ELSE進(jìn)行記述。原則上要用肯定型條件比較。進(jìn)行變量比較時(shí)、原則上不使用神秘?cái)?shù)用全局變量或常數(shù)進(jìn)行比較。例） if nCount = MAX-COUNT then nPage = nPage + 1 endif if nCount = 10 then nPage = nPage + 1 endif5 5 2. FORNEXT把循環(huán)變量寫在 NEXT 的后面使循環(huán)的范圍容易明白例） For nLoop = 1 to 100 nPage = nPage + 1 NEXT nLoop For nLoop = 1 to 100 nPage = nPage + 1 NEXT 5 5 3.SELECTCASE關(guān)于語(yǔ)句的各個(gè)值的意義要寫上注釋。另外、考慮到取得預(yù)期以外的值的情況要加進(jìn)CASE ELSE 語(yǔ)句。SELECT CAES 語(yǔ)句嵌套時(shí)、要寫上注釋使對(duì)應(yīng)的End Select容易被明白。例） Select MSG Case 1 “Yes”的情況 nPage = nPage + 1 Case 2 “