資源描述:
《普英集團Deplhi源代碼編寫規(guī)范.doc》由會員上傳分享,免費在線閱讀,更多相關(guān)內(nèi)容在教育資源-天天文庫。
1、計算機源代碼編寫規(guī)范普英集團Delphi源代碼編寫規(guī)范Version<1.0>撰寫人:薛永坤審核人:劉吉鵬批準(zhǔn)人:劉吉鵬日期:2007-3-5文件修改控制修改記錄編號修改狀態(tài)修改頁碼及條款修改人審核人批準(zhǔn)人修改日期計算機源代碼編寫規(guī)范目錄1.目的2.適用范圍3.規(guī)范內(nèi)容3.1標(biāo)識符命名及書寫規(guī)范3.2注釋規(guī)則3.3縮進規(guī)則3.4窗體3.5控件3.6提示信息計算機源代碼編寫規(guī)范1.目的良好的編程風(fēng)格是提高程序可靠性非常重要的手段,也是大型項目多人合作開發(fā)的技術(shù)基礎(chǔ)。本規(guī)范的目的在于通過規(guī)范定義來避免不好的編程風(fēng)格,增強程序
2、的易讀性,便于自己和其它程序員理解,以下是程序開發(fā)工作流程圖。2.適用范圍本規(guī)定適用于所有軟件的源程序編寫??蛻粲刑厥庖髸r,則遵循客戶提出的要求。對于移植性開發(fā)或低版本的升級開發(fā),則按照該版本的格式要求。3.規(guī)范內(nèi)容3.1標(biāo)識符命名及書寫規(guī)則3.1.1基本規(guī)則計算機源代碼編寫規(guī)范1)這里的標(biāo)識符是指編程語言中語法對象的名字,它們有常量名、變量名、函數(shù)名、類和類型名、文件名等,標(biāo)識符的基本語法是以字母開始,由字母數(shù)字及下劃線組成的單詞。2)標(biāo)識符本身最好能夠表明其自身的含義,以便于使用和他人閱讀。按其在應(yīng)用中的含義由一個
3、或多個詞組成??梢允怯⑽脑~或中文拼音詞。3)當(dāng)標(biāo)識符由多個詞組成時,每個詞的第一個字母大寫,其余全部小寫,常量標(biāo)識符全部大寫。中文詞由中文描述含義的每個漢字的頭一個拼音字母組成。英文詞盡量不縮寫,如果有縮寫,在同一系統(tǒng)中對同一單詞必須使用相同的表示法。4)標(biāo)識的總長度不要超過32個字符。5)具體的3.1.2具體約定1)窗體及單元的命名一個窗體的命名由四部分組成:“Frm”+“公司(B/R/X/…)”+“模快(PUR/INV/…)”+“具體的窗體名”。如:FrmBSysReportShowFrmRPurPurchaseOr
4、derFrmRSysConnection……一個單元的命名由四部分組成:“Unt”+“公司(B/R/X/…)”+“??欤≒UR/INV/…)”+“具體的窗體名”。如:UntBSysReportShowUntRPurPurchaseOrderUntRSysConnection……2)變量及控件的命名一個變量的命名由三部分組成:“范圍前綴”+“類型前綴”+“變量名字”。變量范圍分為三種:全局變量,在模塊中public處以xxx:xxx;來定義,加前綴“G”。如:GStrUserName;GStrDeptName模塊變量,在模
5、塊中private處以xxx:xxx;來定義,加前綴“M”。如:MStrSQL;MStrFlag過程變量,在函數(shù)或過程中Varxxx:xxx;來定義,不加范圍前綴。類型前綴按照其變量類型的不同采用以下字符:序號類型前綴Example1BooleanBlnBlnFound計算機源代碼編寫規(guī)范2Date(Time)DtmDtmStart3IntegerIntIntQuantity4StringStrStrFName5User-definedtypeUdtUdtEmployee6CurrencyCurCurRevenue7Do
6、ubleDblDblTolerance8ByteBytBytRasterData9VariantVntVntCheckSum10SingleSngSngAverage11EditEdtEdtName12BottonBtnBtnClose13ComboxComComCustType14CheckBoxChkChkRun15RadioButtonRbtnRbtnRun16DateTimePickerDtpDtpInvStart17TreeViewTrvTrvList18PopupMenuPmuPmuCheck19MainMe
7、nuMmuMmuMain20MemoMmoMmoText21BitBtnBitnBitnOk22StringGridSgdSgdEmp3.2注釋及格式要求注釋總是加在程序的需要一個概括性說明或不易理解或易理解錯的地方。注釋應(yīng)語言簡練、易懂而又準(zhǔn)確,所采用的語種首選是中文,如有輸入困難、編譯環(huán)境限制或特殊需求也可采用英文。3.2.1源代碼文件的注釋1)在文件的頭部必須標(biāo)明程序名稱,它所完成的主要功能。2)文件的作者,及完成時間。3)階段測試結(jié)束后,主要修改活動的修改人、時間、簡單原因說明列表。4)維護過程中需要修改程序時,
8、應(yīng)在被修改語句前面注明修改時間和原因說明。計算機源代碼編寫規(guī)范3.2.2函數(shù)或過程的注釋//==============================================================////建立時間:建立人://程序功能://修改時間:修改人://修改功能://===========