編碼規(guī)范編寫規(guī)范

《編碼規(guī)范編寫規(guī)范》由會(huì)員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在工程資料-天天文庫(kù)。

1、編碼規(guī)范編寫規(guī)范1.編制目的指導(dǎo)軟件開發(fā)過程編碼規(guī)范的制定，保證軟件產(chǎn)品質(zhì)量，降低軟件開發(fā)與維護(hù)成本，最大限度滿足用戶需求。2.適用范圍適用于應(yīng)用軟件開發(fā)項(xiàng)目、研發(fā)產(chǎn)品開發(fā)、產(chǎn)品客戶化的編碼工作和程序修改。3.文件說(shuō)明1、本文為指南性文件，供參考使用。文件的主體內(nèi)容見所附范例。在實(shí)際使用時(shí)，可以：(1)采用本范例規(guī)定的格式：只需刪除斜體字，并替換成相應(yīng)的內(nèi)容即可；(2)或者，參考本范例，根據(jù)項(xiàng)目情況酌情改變格式、增加或刪減部分內(nèi)容。2、必要時(shí)，可另行編制摘要或?qū)ёx作為編碼規(guī)范的附件,便于閱讀和理解。3、在編制過程中，應(yīng)盡可能多使用實(shí)例，以提高文件的可讀性

2、。變更記錄序號(hào)修改單號(hào)頁(yè)號(hào)條款號(hào)修改人/日期批準(zhǔn)人/日期實(shí)施日期注：對(duì)該文件內(nèi)容增加、刪除或修改均需填寫此變更記錄,詳細(xì)記載變更信息，以保證其可追溯性。1.編制目的12.適用范圍13.文件說(shuō)明11.概述42.代碼的基本格式42.1目錄結(jié)構(gòu)42.2背景42.3代碼文本43.標(biāo)識(shí)符命名53.1標(biāo)識(shí)符命名基本原則53.2分類標(biāo)識(shí)符命名原則54.注釋54.1注釋規(guī)范原則74.2文件頭注釋74.3類與接口注釋84.4函數(shù)過程與方法注釋94.5變量和常量注釋4.6流程和算法注釋4.7數(shù)據(jù)結(jié)構(gòu)注釋?.4.8代碼修改注釋..10錯(cuò)誤!未定義書簽。115.空白規(guī)范錯(cuò)誤！未

3、定義書簽。6.錯(cuò)誤與異常處理錯(cuò)誤！未定義書簽。綜合征管系統(tǒng)升級(jí)改造項(xiàng)目編碼規(guī)范文檔編號(hào)：版本：1.概述一個(gè)軟件的生命周期中，80%的花費(fèi)用于維護(hù)。為方便將來(lái)系統(tǒng)持續(xù)改進(jìn)、升級(jí)等過程屮代碼的可讀性和資源的合理利用，避免重復(fù)勞動(dòng)，特制定本次綜合征管系統(tǒng)升級(jí)改造編碼規(guī)范，以此文檔為參照，統(tǒng)一編碼風(fēng)格，提高編碼質(zhì)量。希望項(xiàng)目組各方參與，集思廣益，不斷改進(jìn)和完善木規(guī)范。2.代碼的基本格式2.1目錄結(jié)構(gòu)srcgovgdlttaxcoresrcgovgdlttaxeventsrcgovgdlttaxguisrcgovgdlttaxweb2.2背

4、景＞描述文件采用的文件名格式。規(guī)范代碼文件名，準(zhǔn)確反映該文件中代碼的主要功能。＞規(guī)范代碼文件名前后綴，應(yīng)遵循程序設(shè)計(jì)語(yǔ)言或開發(fā)工具的具體約定。2.3代碼文本＞每行代碼字符數(shù)量最大120。＞代碼中的縮進(jìn)控制長(zhǎng)度4個(gè)字符。＞開發(fā)人員在開發(fā)工具生成的代碼中附加功能代碼時(shí)，這些附加的功能代碼文本格式應(yīng)盡量和開發(fā)工具生成的代碼文本格式統(tǒng)一。1.標(biāo)識(shí)符命名3.1標(biāo)識(shí)符命名基本原則1?不使用程序設(shè)計(jì)語(yǔ)言的保留字，如【B】Next；[J]interface；【I】import等。2?長(zhǎng)度不超過程序設(shè)計(jì)語(yǔ)言的限制。一般以不超過32個(gè)字符為宜。3?使用英文或英文縮寫，準(zhǔn)確表

5、達(dá)該標(biāo)識(shí)符的功用。4?根據(jù)各程序開發(fā)語(yǔ)言的不同要求，正確使用大小寫格式和前綴、后綴等。3.2分類標(biāo)識(shí)符命名＞詳見國(guó)家稅務(wù)總局金稅三期項(xiàng)目一編碼和命名標(biāo)準(zhǔn)附錄A《JAVA編碼規(guī)范》＞詳見國(guó)家稅務(wù)總局金稅三期項(xiàng)目一編碼和命名標(biāo)準(zhǔn)附錄B《網(wǎng)站設(shè)計(jì)技術(shù)規(guī)范》4.命名規(guī)則4.1包的命名規(guī)則＞包的命名以業(yè)務(wù)框架為準(zhǔn)。＞包的層級(jí)要與業(yè)務(wù)框架的層級(jí)一致。＞包命名時(shí)采用中文和英文結(jié)合的方式。＞包的名稱首字母必須為小寫。名稱由多個(gè)單詞組成時(shí),第二組單詞首字母應(yīng)大寫。4.2類與接口的命名規(guī)則＞類名采用半角英文字符書寫，統(tǒng)一以中文或英文描述,類名簡(jiǎn)潔而按名知意,可以使用縮略語(yǔ),

6、采用小寫字母命名，每一個(gè)單詞的首字母大寫。＞接口命名使用接口名，單純實(shí)現(xiàn)某個(gè)接口的類使用接口名+-imPr9命名。4.3JSP、JS或GUI頁(yè)面的命名規(guī)則＞類名采用半角英文字符書寫，統(tǒng)一以中文或英文描述,JSP文件名簡(jiǎn)潔而按名知意，可以使用縮略語(yǔ)，采用小寫字母命名。＞文件命名使用［操作類別］-［功能模塊名稱］.JSPo＞［操作類別］包括錄入-insert、修改-update＞查詢-viewo4.4常量的命名規(guī)則＞Java中，常量，即不變的值，一般用類的靜態(tài)常量字段來(lái)實(shí)現(xiàn)。公認(rèn)的約定是，采用完整的英文大寫單詞,在詞與詞之間用下劃線連接。示例：MINIMUM

7、_BALANCEMAX_VALUEDEFAUET_START_DATE4.5變量的命名規(guī)則＞應(yīng)采用完整的英文描述符來(lái)命名字段，以便使字段所表達(dá)的意思一目了然。象數(shù)組或者矢量這樣是集合的字段，命名時(shí)應(yīng)使用復(fù)數(shù)來(lái)表示它們代表多值。示例：firstNamezipCodeunitPricediscountRateorderitems5.注釋5.1注釋規(guī)范原則＞源代碼中的注釋可以使用中文或英文，但必須準(zhǔn)確、完整的描述被注釋內(nèi)容，不產(chǎn)生歧義。＞源代碼中的注釋格式要符合程序設(shè)計(jì)語(yǔ)言的語(yǔ)法要求。＞多行注釋中應(yīng)根據(jù)情況適當(dāng)插入空行，以便于閱讀。5.2文件頭注釋＞源文件名稱

8、。＞源文件中代碼的主要功能介紹。＞版權(quán)信息，如屬部分版權(quán)或無(wú)版權(quán)源代碼，應(yīng)注明具