計(jì)算機(jī)源代碼編寫(xiě)規(guī)范

《計(jì)算機(jī)源代碼編寫(xiě)規(guī)范》由會(huì)員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在行業(yè)資料-天天文庫(kù)。

1、計(jì)算機(jī)源代碼編寫(xiě)規(guī)范Ver2.1P-6/6計(jì)算機(jī)源代碼編寫(xiě)規(guī)范文件編號(hào)：NW506104生效日期：2000.3.20受控編號(hào)：密級(jí)：秘密版次：Ver2.1修改狀態(tài)：總頁(yè)數(shù)6正文6附錄0編制：馬云生審核：袁淮批準(zhǔn)：孟莉沈陽(yáng)東大阿爾派軟件股份有限公司（版權(quán)所有，翻版必究）沈陽(yáng)東大阿爾派軟件股份有限公司計(jì)算機(jī)源代碼編寫(xiě)規(guī)范Ver2.1P-6/6文件修改控制修改記錄編號(hào)修改狀態(tài)修改頁(yè)碼及條款修改人審核人批準(zhǔn)人修改日期沈陽(yáng)東大阿爾派軟件股份有限公司計(jì)算機(jī)源代碼編寫(xiě)規(guī)范Ver2.1P-6/6目錄1.目的2.適用范圍3.術(shù)語(yǔ)及縮略語(yǔ)4.規(guī)范內(nèi)容4.1標(biāo)識(shí)符命名

2、及書(shū)寫(xiě)規(guī)范4.2注釋規(guī)則4.3縮進(jìn)規(guī)則沈陽(yáng)東大阿爾派軟件股份有限公司計(jì)算機(jī)源代碼編寫(xiě)規(guī)范Ver2.1P-6/61.目的良好的編程風(fēng)格是提高程序可靠性非常重要的手段，也是大型項(xiàng)目多人合作開(kāi)發(fā)的技術(shù)基礎(chǔ)。本規(guī)范的目的在于通過(guò)規(guī)范定義來(lái)避免不好的編程風(fēng)格，增強(qiáng)程序的易讀性，便于自己和其它程序員理解。2.適用范圍本規(guī)定適用于所有軟件的源程序編寫(xiě)?？蛻粲刑厥庖髸r(shí)，則遵循客戶提出的要求。對(duì)于移植性開(kāi)發(fā)或低版本的升級(jí)開(kāi)發(fā)，則按照前一版本的格式要求。3.術(shù)語(yǔ)及縮略語(yǔ)本程序采用NQ402100《質(zhì)量手冊(cè)》中的術(shù)語(yǔ)和縮略語(yǔ)及其定義。4.規(guī)范內(nèi)容4.1標(biāo)識(shí)符命名及書(shū)

3、寫(xiě)規(guī)則4.1.1基本規(guī)則1)這里的標(biāo)識(shí)符是指編程語(yǔ)言中語(yǔ)法對(duì)象的名字，它們有常量名、變量名、函數(shù)名、類(lèi)和類(lèi)型名、文件名等，標(biāo)識(shí)符的基本語(yǔ)法是以字母開(kāi)始，由字母數(shù)字及下劃線組成的單詞。2)標(biāo)識(shí)符本身最好能夠表明其自身的含義，以便于使用和他人閱讀。按其在應(yīng)用中的含義由一個(gè)或多個(gè)詞組成?？梢允怯⑽脑~或中文拼音詞。3)當(dāng)標(biāo)識(shí)符由多個(gè)詞組成時(shí)，每個(gè)詞的第一個(gè)字母大寫(xiě)，其余全部小寫(xiě)，常量標(biāo)識(shí)符全部大寫(xiě)。中文詞由中文描述含義的每個(gè)漢字的頭一個(gè)拼音字母組成。英文詞盡量不縮寫(xiě)，如果有縮寫(xiě)，在同一系統(tǒng)中對(duì)同一單詞必須使用相同的表示法。4)標(biāo)識(shí)的總長(zhǎng)度不要超過(guò)32個(gè)字

4、符。4.1.2特殊約定有的編程工具或項(xiàng)目開(kāi)發(fā)小組對(duì)標(biāo)識(shí)符的命名有自己的規(guī)定，例如，把標(biāo)識(shí)符分為兩部分：規(guī)范標(biāo)識(shí)前綴+含義標(biāo)識(shí)沈陽(yáng)東大阿爾派軟件股份有限公司計(jì)算機(jī)源代碼編寫(xiě)規(guī)范Ver2.1P-6/61)規(guī)范標(biāo)識(shí)前綴用來(lái)標(biāo)明該標(biāo)識(shí)的歸類(lèi)特征，以便與其它類(lèi)型的標(biāo)識(shí)互相區(qū)別，例如：字符串變量標(biāo)識(shí)符的前綴為str，某字符串變量可命名為：strExample；文本框?qū)ο髽?biāo)識(shí)符的前綴為txt，某文本框?qū)ο蟮拿蔀椋簍xtExample；2)含義標(biāo)識(shí)用來(lái)標(biāo)明該標(biāo)識(shí)所對(duì)應(yīng)的被抽象的實(shí)體，以便記憶，上面例子中“strExample”的“Example”就是含義標(biāo)識(shí)

5、。編程工具或項(xiàng)目開(kāi)發(fā)小組有特殊約定的，以他們的約定為準(zhǔn)。4.1.3源代碼文件標(biāo)識(shí)符命名規(guī)則源代碼文件標(biāo)識(shí)符分為兩部分，即文件名前綴和后綴。格式、規(guī)則如下：×××……××.×××1）前綴部分通常與該文件所表示的內(nèi)容或作用有關(guān)?？梢杂身?xiàng)目組成員統(tǒng)一約定。2）后綴部分通常表示該文件的類(lèi)型，可以自己給定，具體的編程環(huán)境有特殊規(guī)定的以編程環(huán)境的規(guī)定為準(zhǔn)。3）前綴和后綴這兩部分字符應(yīng)僅使用字母、數(shù)字和下劃線。文件標(biāo)識(shí)的長(zhǎng)度不能超過(guò)32個(gè)字符，以便于識(shí)別。4.2注釋及格式要求注釋總是加在程序的需要一個(gè)概括性說(shuō)明或不易理解或易理解錯(cuò)的地方。注釋?xiě)?yīng)語(yǔ)言簡(jiǎn)煉、易懂而

6、又準(zhǔn)確，所采用的語(yǔ)種首選是中文，如有輸入困難、編譯環(huán)境限制或特殊需求也可采用英文。4.2.1源代碼文件的注釋1)在文件的頭部必須標(biāo)明程序名稱，它所完成的主要功能。2)文件的作者，及完成時(shí)間。3)階段測(cè)試結(jié)束后，主要修改活動(dòng)的修改人、時(shí)間、簡(jiǎn)單原因說(shuō)明列表。4)維護(hù)過(guò)程中需要修改程序時(shí)，應(yīng)在被修改語(yǔ)句前面注明修改時(shí)間和原因說(shuō)明。4.2.2函數(shù)或過(guò)程的注釋1)在函數(shù)頭部必須對(duì)函數(shù)進(jìn)行功能和參數(shù)（值參、變參）說(shuō)明；2)在函數(shù)的主體部分，如算法復(fù)雜時(shí)，應(yīng)以注釋的方式對(duì)其算法結(jié)構(gòu)作出說(shuō)明；3)函數(shù)申請(qǐng)過(guò)全局資源且有可能導(dǎo)致資源緊張應(yīng)加以注明(如內(nèi)存，文件柄

7、等)；4)函數(shù)有副作用一定以十分醒目的方式（如加!號(hào)等）注明；5)函數(shù)的長(zhǎng)度在100語(yǔ)句行以內(nèi)（不包括注釋），程序有特殊要求時(shí)（如速度要求等）可以例外。沈陽(yáng)東大阿爾派軟件股份有限公司計(jì)算機(jī)源代碼編寫(xiě)規(guī)范Ver2.1P-6/64.2.3語(yǔ)句的注釋1)應(yīng)對(duì)不易理解的分支條件表達(dá)式加注釋；2)不易理解的循環(huán)，應(yīng)說(shuō)明出口條件(有GOTO的程序還應(yīng)說(shuō)明入口條件)；3)過(guò)長(zhǎng)的函數(shù)實(shí)現(xiàn)，應(yīng)將其語(yǔ)句按實(shí)現(xiàn)的功能分段加以概括性說(shuō)明；4)供別的文件或函數(shù)調(diào)用的函數(shù)，絕不應(yīng)使用全局變量交換數(shù)據(jù)。4.2.4常量和變量的注釋在常量名字(或有宏機(jī)制的語(yǔ)言中的宏)聲明后應(yīng)對(duì)該

8、名字作適當(dāng)注釋，注釋說(shuō)明的要點(diǎn)是：1)被保存值的含義(必須)；2)合法取值的范圍(可選)；3)全局量需要對(duì)以上逐點(diǎn)做充分的說(shuō)明。4.3縮