技術(shù)規(guī)范知識(shí)84(已修改)
2025-04-27 23:11 本頁面
【正文】 17 / 20編碼標(biāo)準(zhǔn) 批準(zhǔn)人劉巖審核人崔戈擬制人劉慧豐批準(zhǔn)日期1999．5．12生效日期1999．5．12關(guān)聯(lián)文件沈陽東東系統(tǒng)集成有限公司更改記錄序號(hào)發(fā)行日更改對(duì)象更改內(nèi)容批準(zhǔn)審查擬制01999．5．12新發(fā)行劉巖崔戈劉慧豐目 錄1. 目的 2/42. 編碼的注意事項(xiàng) 2/43. 編碼風(fēng)格 2/44. 序言性注釋格式 3/4附錄頭注釋樣例 1/4(附) 編碼是以程序設(shè)計(jì)時(shí)做成的程序規(guī)范書、流程等邏輯設(shè)計(jì)書為基礎(chǔ)。在編碼時(shí)，為減少在編碼水平上的個(gè)人差異、順利地進(jìn)入單體試驗(yàn)階段,以及便于進(jìn)行調(diào)試和提高維護(hù)效率，特制定本標(biāo)準(zhǔn)。本標(biāo)準(zhǔn)作為代碼的書寫標(biāo)準(zhǔn)，其主要目的在于統(tǒng)一程序設(shè)計(jì)的記述風(fēng)格，培養(yǎng)良好的編碼習(xí)慣，使代碼記述清晰、明確，具有良好的可讀性。良好的編碼習(xí)慣可以幫助程序員避開不必要的語法或語義錯(cuò)誤，對(duì)出現(xiàn)的錯(cuò)誤迅速定位。另外，良好的編碼習(xí)慣還有助于在編碼過程中對(duì)程序的設(shè)計(jì)思路進(jìn)行驗(yàn)證和提示。本規(guī)范作為編碼的通常標(biāo)準(zhǔn)，希望每個(gè)人都可以通過按此規(guī)范進(jìn)行編碼，提高程序的可讀性、可修改性及維護(hù)的效率。如果程序由用戶指定記述標(biāo)準(zhǔn)或使用（半）自動(dòng)生成工具時(shí)，可適當(dāng)遵循其標(biāo)準(zhǔn)。(1)認(rèn)真分析理解系統(tǒng)設(shè)計(jì)書、程序設(shè)計(jì)書（有時(shí)也包括流程圖）。在很好地理解上述文件的基礎(chǔ)上編碼 （特別是在程序設(shè)計(jì)書與編碼的擔(dān)當(dāng)者不同時(shí)）。對(duì)于不明確之處不可隨意判斷，應(yīng)確認(rèn)后再進(jìn)行。(2)要注意把編制容易理解（易讀）的程序放到第一位。在頭腦中要經(jīng)?？紤]程序的讀者，按照向讀者說明的方式來寫是一個(gè)竅門。讀起來容易理解的程序一般質(zhì)量都比較好、修改維護(hù)也容易。(3)在編碼的過程中發(fā)現(xiàn)了設(shè)計(jì)上的問題時(shí)，要向上追溯到系統(tǒng)設(shè)計(jì)書／程序設(shè)計(jì)書。不可輕易地判斷，而應(yīng)經(jīng)設(shè)計(jì)者確認(rèn)。(4)關(guān)于數(shù)據(jù)庫的記錄規(guī)范等的包含文件、模塊頭、宏等，要采用系統(tǒng)統(tǒng)一的規(guī)定。個(gè)人不可隨意地制作。否則就會(huì)為以后修改、改造造成困難。(5)在編碼結(jié)束后，要對(duì)編碼重查。不可未經(jīng)充分的重查而隨便進(jìn)入下一步測(cè)試階段。編碼重查作為最簡(jiǎn)便的故障檢查手段，也是非常有效的手段，有時(shí)可以檢查出在試驗(yàn)工程中不能全部檢查出的復(fù)雜的錯(cuò)誤。編碼的目標(biāo)首先是清晰正確，其次才是程序的效率。以下是在編程時(shí)應(yīng)遵守規(guī)則。(1)合理使用goto語句。合理使用goto語句可以提高代碼的運(yùn)行效率，但goto語句的使用會(huì)破壞程序的結(jié)構(gòu)特性，因此要限制使用的范圍。(2)用括號(hào)體現(xiàn)優(yōu)先級(jí)和嵌套的層次。用括號(hào)體現(xiàn)優(yōu)先級(jí)和嵌套的層次可使程序更清晰，并且能夠有效地避免二義性。(3)利用標(biāo)準(zhǔn)書寫格式提高程序的可讀性。a． 用分層縮進(jìn)顯示嵌套結(jié)構(gòu)的層次。b． 每行只寫一條語句。c． 在注釋段的周圍加邊框。d． 在注釋段與程序段以及不同程序段之間插入空行。(4)命名規(guī)則。命名應(yīng)有實(shí)際意義，一般格式為：前綴+由形容詞、名詞或動(dòng)詞組成的詞組。前綴由使用的語言決定。(5)適當(dāng)?shù)淖⑨?。適當(dāng)?shù)淖⑨屇芴岣叱绦虻目勺x性，但過多的注釋不但不能提高程序的可讀性，還會(huì)降低效率，因此注釋一定要適當(dāng)。注釋分為序言性注釋和功能性注釋兩種。在文件頭、模塊頭、函數(shù)和過程的頭部的注釋屬于序言性注釋。包括以下幾部分內(nèi)容：a． 功能描述。對(duì)所執(zhí)行的功能進(jìn)行簡(jiǎn)略的介紹。b． 接口描述。簡(jiǎn)述各輸入?yún)?shù)和返回值。c． 數(shù)據(jù)
公司管理相關(guān)推薦
鄂ICP備17016276號(hào)-1