計算機源代碼編寫規(guī)范
計算機源代碼編寫規(guī)范 |文件編號： |生效日期： |受控編號： | |NW506104 |2000.3.20 | | |密級：秘密 |版次：Ver2.1 |修改狀態(tài)： | |總頁數(shù) |6 |正文 |6 |附錄 |0 | |編制：馬云生 |審核：袁淮 |批準(zhǔn)：孟莉 | 沈陽東大阿爾派軟件股份有限公司 （版權(quán)所有，翻版必究） 文件修改控制 |修改記錄編號 |修改 |修改頁碼及條款 |修改人|審核人|批準(zhǔn)人|修改日期 | | |狀態(tài) | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 目錄 1. 目的 2. 適用范圍 3. 術(shù)語及縮略語 4. 規(guī)范內(nèi)容 1 標(biāo)識符命名及書寫規(guī)范 2 注釋規(guī)則 3 縮進(jìn)規(guī)則 1. 目的 良好的編程風(fēng)格是提高程序可靠性非常重要的手段，也是大型項目多人合作開發(fā)的技 術(shù)基礎(chǔ)。本規(guī)范的目的在于通過規(guī)范定義來避免不好的編程風(fēng)格，增強程序的易讀性 ，便于自己和其它程序員理解。 2. 適用范圍 本規(guī)定適用于所有軟件的源程序編寫?？蛻粲刑厥庖髸r，則遵循客戶提出的要求。 對于移植性開發(fā)或低版本的升級開發(fā)，則按照前一版本的格式要求。 3. 術(shù)語及縮略語 本程序采用NQ402100《質(zhì)量手冊》中的術(shù)語和縮略語及其定義。 1. 規(guī)范內(nèi)容 4.1 標(biāo)識符命名及書寫規(guī)則 4.1.1 基本規(guī)則 1) 這里的標(biāo)識符是指編程語言中語法對象的名字，它們有常量名、變量名、函 數(shù)名、類和類型名、文件名等，標(biāo)識符的基本語法是以字母開始，由字母 數(shù)字及下劃線組成的單詞。 2) 標(biāo)識符本身最好能夠表明其自身的含義，以便于使用和他人閱讀。按其在應(yīng) 用中的含義由一個或多個詞組成。可以是英文詞或中文拼音詞。 3) 當(dāng)標(biāo)識符由多個詞組成時，每個詞的第一個字母大寫，其余全部小寫，常量 標(biāo)識符全部大寫。中文詞由中文描述含義的每個漢字的頭一個拼音字母組 成。英文詞盡量不縮寫，如果有縮寫，在同一系統(tǒng)中對同一單詞必須使用 相同的表示法。 4) 標(biāo)識的總長度不要超過32個字符。 4.1.2 特殊約定 有的編程工具或項目開發(fā)小組對標(biāo)識符的命名有自己的規(guī)定，例如，把標(biāo)識符 分為兩部分： 規(guī)范標(biāo)識前綴+含義標(biāo)識 1) 規(guī)范標(biāo)識前綴用來標(biāo)明該標(biāo)識的歸類特征，以便與其它類型的標(biāo)識互相區(qū)別 ，例如：字符串變量標(biāo)識符的前綴為str，某字符串變量可命名為：strEx ample；文本框?qū)ο髽?biāo)識符的前綴為txt，某文本框?qū)ο蟮拿蔀椋簍xtE xample； 2) 含義標(biāo)識用來標(biāo)明該標(biāo)識所對應(yīng)的被抽象的實體，以便記憶，上面例子中“ strExample”的“Example”就是含義標(biāo)識。編程工具或項目開發(fā)小組有特殊 約定的，以他們的約定為準(zhǔn)。 1. 3 源代碼文件標(biāo)識符命名規(guī)則 源代碼文件標(biāo)識符分為兩部分，即文件名前綴和后綴。格式、規(guī)則如下： ×××……××.××× 1. 前綴部分通常與該文件所表示的內(nèi)容或作用有關(guān)?？梢杂身椖拷M成員統(tǒng)一約 定。 2. 后綴部分通常表示該文件的類型，可以自己給定，具體的編程環(huán)境有特殊規(guī) 定的以編程環(huán)境的規(guī)定為準(zhǔn)。 2. 前綴和后綴這兩部分字符應(yīng)僅使用字母、數(shù)字和下劃線。文件標(biāo)識的長度不 能超過32個字符，以便于識別。 4.2 注釋及格式要求 注釋總是加在程序的需要一個概括性說明或不易理解或易理解錯的地方。注釋 應(yīng)語言簡煉、易懂而又準(zhǔn)確，所采用的語種首選是中文，如有輸入困難、編譯 環(huán)境限制或特殊需求也可采用英文。 4.2.1 源代碼文件的注釋 1) 在文件的頭部必須標(biāo)明程序名稱，它所完成的主要功能。 2) 文件的作者，及完成時間。 3) 階段測試結(jié)束后，主要修改活動的修改人、時間、簡單原因說明列表。 4) 維護(hù)過程中需要修改程序時，應(yīng)在被修改語句前面注明修改時間和原因說明 。 4.2.2 函數(shù)或過程的注釋 1) 在函數(shù)頭部必須對函數(shù)進(jìn)行功能和參數(shù)（值參、變參）說明； 2) 在函數(shù)的主體部分，如算法復(fù)雜時，應(yīng)以注釋的方式對其算法結(jié)構(gòu)作出說明； 3) 函數(shù)申請過全局資源且有可能導(dǎo)致資源緊張應(yīng)加以注明(如內(nèi)存，文件柄等 )； 4) 函數(shù)有副作用一定以十分醒目的方式（如加!號等）注明； 5) 函數(shù)的長度在100語句行以內(nèi)（不包括注釋），程序有特殊要求時（如速度 要求等）可以例外。 4.2.3 語句的注釋 1) 應(yīng)對不易理解的分支條件表達(dá)式加注釋； 2) 不易理解的循環(huán)，應(yīng)說明出口條件(有GOTO的程序還應(yīng)說明入口條件)； 3) 過長的函數(shù)實現(xiàn)，應(yīng)將其語句按實現(xiàn)的功能分段加以概括性說明； 4) 供別的文件或函數(shù)調(diào)用的函數(shù)，絕不應(yīng)使用全局變量交換數(shù)據(jù)。 4.2.4 常量和變量的注釋 在常量名字(或有宏機制的語言中的宏)聲明后應(yīng)對該名字作適當(dāng)注釋，注釋說 明的要點是： 1) 被保存值的含義(必須)； 2) 合法取值的范圍(可選)； 3) 全局量需要對以上逐點做充分的說明。 4.3 縮進(jìn)規(guī)則 4.3.1 控制結(jié)構(gòu)的縮進(jìn) 程序應(yīng)以縮進(jìn)形式展現(xiàn)程序的塊結(jié)構(gòu)和控制結(jié)構(gòu)，在不影響展示程序結(jié)構(gòu)的前 提下盡可能地減少縮進(jìn)的層次。采用如下兩種縮進(jìn)方式之一： |1） |2） | |if (expression ) |if (expression ){ | |{ |statements | |statements |} | |} |else{ | |else |statements | |{ |} | |statements | | |} | | 4.3.2 縮進(jìn)的限制 一個程序的寬度如果超出頁寬或屏寬，這將是很難讀的，所以本規(guī)范要求使用 折行縮進(jìn)的方法、合并表達(dá)式或編寫子程序的方法來限制程序的寬度。 1）任何一個程序最大行寬不得超過80列，超過者應(yīng)折行書寫。 2）建議一個函數(shù)的縮進(jìn)不得超過5級，超過者應(yīng)將其子塊寫為子函數(shù)； 3）算法或程序本身的特性有特殊要求時，可以超過5級。 ----------------------- [pic]
計算機源代碼編寫規(guī)范