軟件編碼和命名規(guī)范

《軟件編碼和命名規(guī)范》由會(huì)員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在教育資源-天天文庫。

1、XXXXXXXX有限公司XXXX項(xiàng)目編碼和命名規(guī)范XXXXXX項(xiàng)目編碼和命名規(guī)范項(xiàng)目號(hào)版本號(hào)作成者確認(rèn)者承認(rèn)者制定日CONFIDENTIAL24/24XXXXXXXX有限公司XXXX項(xiàng)目編碼和命名規(guī)范變更記錄版本發(fā)布日擔(dān)當(dāng)者內(nèi)容CONFIDENTIAL24/24XXXXXXXX有限公司XXXX項(xiàng)目編碼和命名規(guī)范目錄變更記錄2目錄31.概述51.1.目的51.2.構(gòu)成52.詳述62.1.版權(quán)聲明62.2.文件結(jié)構(gòu)72.2.1.頭文件結(jié)構(gòu)72.2.2.定義文件的結(jié)構(gòu)73.命名規(guī)則93.1共性規(guī)則93.2標(biāo)準(zhǔn)字典114.注釋135.程序版式155.1?縮進(jìn)155.2?空行155.3?代碼行155.

2、4?對(duì)齊165.5?修飾符的位置186.語法規(guī)范196.1?運(yùn)算符的優(yōu)先級(jí)19CONFIDENTIAL24/24XXXXXXXX有限公司XXXX項(xiàng)目編碼和命名規(guī)范6.2?switch?語句196.3?函數(shù)參數(shù)196.4?goto語句207.關(guān)于可自動(dòng)添加注釋的宏217.1?概述217.2?功能217.2.1.XXXX_InsertFileHeader217.2.2XXXX_InsertFuncNote217.2.3XXXX_CreateFuncNote227.2.4XXXX_DeleteNote227.2.5XXXX_ModifyNote227.2.6XXXX_Note237.3?配置23C

3、ONFIDENTIAL24/24XXXXXXXX有限公司XXXX項(xiàng)目編碼和命名規(guī)范1.概述1.1.目的在XXXX項(xiàng)目架構(gòu)設(shè)計(jì)開始之時(shí)，有必要建立起適合本項(xiàng)目的編碼規(guī)范以及命名規(guī)約，為順利開展軟件架構(gòu)設(shè)計(jì)及隨后的各階段設(shè)計(jì)工作提供必要的基準(zhǔn)和規(guī)范。本編碼規(guī)范是在《XX軟件課編碼規(guī)范》的基礎(chǔ)上，根據(jù)本案的特點(diǎn)進(jìn)行必要的補(bǔ)充和修正而制定完成的。此編碼規(guī)范是以C語言作為開發(fā)語言的前提下編寫的，在項(xiàng)目的整個(gè)生命周期中，以此作為開發(fā)工作開展的基準(zhǔn)。1.2.構(gòu)成XXXX項(xiàng)目編碼規(guī)范主要由以下幾個(gè)部分構(gòu)成：(1)版權(quán)聲明。(2)文件結(jié)構(gòu)。(3)命名規(guī)則。(4)程序版式。(5)語法規(guī)范。(6)自動(dòng)注釋添加。C

4、ONFIDENTIAL24/24XXXXXXXX有限公司XXXX項(xiàng)目編碼和命名規(guī)范2.詳述122.1.版權(quán)聲明版權(quán)聲明位于頭文件和定義文件的開頭（參見示例1-1），主要內(nèi)容有：(1)版權(quán)信息(2)文件名稱，摘要(3)日期，作者和修改內(nèi)容示例2-1版權(quán)聲明【規(guī)則2-1-1】修改內(nèi)容要注明修改原因，比如Bug修正、式樣變更和增加新功能等。CONFIDENTIAL24/24XXXXXXXX有限公司XXXX項(xiàng)目編碼和命名規(guī)范2.2.文件結(jié)構(gòu)2.2.1.頭文件結(jié)構(gòu)頭文件由四部分內(nèi)容組成：(1)頭文件開始處的版權(quán)聲明（參見示例2-1）。(2)預(yù)處理塊。(3)宏定義。(4)函數(shù)和結(jié)構(gòu)體的聲明。假設(shè)頭文件名

5、稱為Head.h，頭文件的結(jié)構(gòu)參見示例2-2?！疽?guī)則2-2-1】為了防止頭文件被重復(fù)引用，應(yīng)當(dāng)用預(yù)編譯偽指令ifndef/define/endif結(jié)構(gòu)產(chǎn)生預(yù)處理塊。假設(shè)頭文件名稱為Head.h，Head.h變?yōu)镠EAD_H在頭文件中的預(yù)編譯偽指令中使用，參見示例2-1。【規(guī)則2-2-2】用#include格式來引用標(biāo)準(zhǔn)庫的頭文件?！疽?guī)則2-2-3】用#include“filename.h”格式來引用非標(biāo)準(zhǔn)庫的頭文件。示例2-2頭文件的結(jié)構(gòu)2.2.2.定義文件的結(jié)構(gòu)定義文件有四部分內(nèi)容：(1)定義文件開頭處的版權(quán)聲明（參見示例2-1）。(2)對(duì)頭文件的引用。(3)宏定義

6、、函數(shù)的引用聲明及變量定義。(4)程序的實(shí)現(xiàn)體。CONFIDENTIAL24/24XXXXXXXX有限公司XXXX項(xiàng)目編碼和命名規(guī)范定義文件的結(jié)構(gòu)參見示例2-3。示例2-3定義文件的結(jié)構(gòu)CONFIDENTIAL24/24XXXXXXXX有限公司XXXX項(xiàng)目編碼和命名規(guī)范3.命名規(guī)則3.1共性規(guī)則命名的兩個(gè)基本原則：(1)含義清晰，不易混淆。(2)不和其它模塊、系統(tǒng)API的命名相沖突?！疽?guī)則3-1-1】標(biāo)識(shí)符應(yīng)當(dāng)直觀且可以拼讀，可望文知意。標(biāo)識(shí)符應(yīng)采用英文單詞或其組合，便于記憶和閱讀。切忌使用漢語拼音來命名。程序中的英文單詞不應(yīng)太復(fù)雜，用詞應(yīng)當(dāng)準(zhǔn)確?！疽?guī)則3-1-2】標(biāo)識(shí)符的長(zhǎng)度應(yīng)當(dāng)符合“mi

7、n-length&&max-information”原則。例如：變量名MaxVal就比MaxValueUntilOverflow，簡(jiǎn)潔易懂?！疽?guī)則3-1-3】程序中不要出現(xiàn)僅靠大小寫區(qū)分的相似的標(biāo)識(shí)符。例如：intx,X;/*變量x與X容易混淆*/voidfoo(intx);/*函數(shù)foo與FOO容易混淆*/voidFOO(floatx);【規(guī)則3-1-4】程序中不要出現(xiàn)標(biāo)識(shí)符完全相同的局部變量和全局變量，盡