【正文】 一。 /* bit 1 6 */ unsigned int A3: 1。自定義數(shù)據(jù)類(lèi)型、合理地設(shè)計(jì)數(shù)據(jù)并使用自定義數(shù)據(jù)類(lèi)型 合理地設(shè)計(jì)數(shù)據(jù)并使用自定義數(shù)據(jù)類(lèi)型，避免數(shù)據(jù)間進(jìn)行不必要的類(lèi)型轉(zhuǎn)換。typedef unsigned int DWORD。char chr。指針、不應(yīng)對(duì)指針變量使用強(qiáng)制類(lèi)型轉(zhuǎn)換賦值、不應(yīng)把自動(dòng)類(lèi)型的局部變量的地址賦值給外部指針局部變量的地址賦值給外部或者范圍更大的指針，如果局部變量不是靜態(tài)的，那么這種用法是不安全的。 uint uiPointTmp。 puiPoint = puiPoint + 2。錯(cuò)誤用法示例： uchar aucFirst[10]。 pucSecond = aucArray + 2。 ... *puiApp = amp。 return。uiTemp。 uint uiTemp。 uiTmp = puiFirst – puiSecond。 uint auiPointTmp[10]。、指針轉(zhuǎn)換過(guò)程中不應(yīng)丟失指針的const、 volatile屬性、只有指向數(shù)組的指針才允許進(jìn)行算術(shù)運(yùn)算 此處的算術(shù)運(yùn)算僅僅限定于指針加減某個(gè)整數(shù)，比如pucPoint = pucPoint 5, pucPoint++等。無(wú)符號(hào)數(shù)轉(zhuǎn)換為有符號(hào)數(shù)，可能得到一個(gè)負(fù)值。說(shuō)明：當(dāng)進(jìn)行數(shù)據(jù)類(lèi)型強(qiáng)制轉(zhuǎn)換時(shí)，其數(shù)據(jù)的意義、轉(zhuǎn)換后的取值等都有可能發(fā)生變化，而這些細(xì)節(jié)若考慮不周，就很有可能留下隱患。typedef unsigned char BYTE。 1 8 16 24 32 | long1 | long1 | long1 | long1 | | | | | long2 | | long2 | long2 | long2 | | | ...、struct或union類(lèi)型中至少應(yīng)有一個(gè)成員、struct或union類(lèi)型的成員類(lèi)型struct或union類(lèi)型的成員不應(yīng)是void類(lèi)型、函數(shù)類(lèi)型、未知大小的數(shù)組和含有未知內(nèi)容的struct或union枚舉、枚舉元素的初始化應(yīng)完整枚舉元素的初始化只有兩種形式是安全的，一是初始化所有元素，二是只初始化第一個(gè)元素。typedef struct EXAM_BIT_STRU{ /* Intel 68360 */ unsigned int A1: 1。} EXAMPLE。typedef struct EXAMPLE_STRU{ unsigned int uiValid: 1。 unsigned char ucTel。說(shuō)明：增加結(jié)構(gòu)的可理解性、可操作性和可維護(hù)性。typedef struct PERSON_STRU{ unsigned char aucName[8]。 unsigned char ucSex。s sex, as follows // 0 FEMALE。 // teacher sex, as follows // 0 FEMALE。s sex, as follows // 0 FEMALE。結(jié)構(gòu)中的各元素應(yīng)代表同一事務(wù)的不同側(cè)面，而不應(yīng)把描述沒(méi)有關(guān)系或關(guān)系很弱的不同事務(wù)的元素放到同一結(jié)構(gòu)中。 int　length, width；int i, j, k。、公共變量?jī)H由模塊或函數(shù)創(chuàng)建和修改，其余模塊和函數(shù)只能訪問(wèn)構(gòu)造僅有一個(gè)模塊或函數(shù)可以修改、創(chuàng)建，而其余有關(guān)模塊或函數(shù)只訪問(wèn)的公共變量，防止多個(gè)不同模塊或函數(shù)都可以修改、創(chuàng)建同一公共變量的現(xiàn)象。這種關(guān)系的說(shuō)明可在注釋或文檔中描述。 // 此二語(yǔ)句功能相當(dāng)于“ * stat_poi ++ += 1。用多行簡(jiǎn)單語(yǔ)句替代復(fù)雜語(yǔ)句不要使用難懂的技巧性很高的語(yǔ)句，除非很有必要時(shí)。 = 10。 d，(3)造成了判斷條件出錯(cuò)。 d由于high 8 | low = ( high 8) | low,a | b amp。示例：下列語(yǔ)句中的表達(dá)式word = (high 8) | low (1)if ((a | b) amp。 //if mtp receive a message from links if (receive_flag)1在程序塊的結(jié)束行右方加注釋標(biāo)記，以表明某程序塊的結(jié)束說(shuō)明：當(dāng)代碼段較長(zhǎng)，特別是多重嵌套時(shí)，這樣做可以使代碼更清晰，更便于閱讀。 break。case CMD_FWD: ProcessFwd()。void example_fun( void ){//code one ments CodeBlock One // code two ments CodeBlock Two}應(yīng)改為如下布局。 示例：//active statistic task number define MAX_ACT_TASK_NUMBER 1000define MAX_ACT_TASK_NUMBER 1000 //active statistic task number數(shù)據(jù)結(jié)構(gòu)命名不能充分自注釋的，必須加以注釋數(shù)據(jù)結(jié)構(gòu)聲明(包括數(shù)組、結(jié)構(gòu)、類(lèi)、枚舉等)，如果其命名不是充分自注釋的，必須加以注釋。例1：//get replicate sub system index and net indicator ucRepssnInd = aucSsnData[ucIndex].ucRepssnIndex。如果函數(shù)有調(diào)用全局變量，也要在此 進(jìn)行詳細(xì)說(shuō)明。 i++)和if ((a=b) amp。 // 地址操作amp。a = b ^ 2。(5)、如果‘。說(shuō)明：采用這種松散方式編寫(xiě)代碼的目的是使代碼更加清晰。endifendif BackToNormal()。 左大括號(hào)“{”后和右大括號(hào)“}”前不可出現(xiàn)代碼，并且與引用他的語(yǔ)句左對(duì)齊。amp。示例：if ((ucTaskNo TMP_MAX_TASK_NUMBER) amp。 (ucRetCode == 0)){ *pucErrCode = EPRONTCENTER。}應(yīng)如下書(shū)寫(xiě)：if ((ucCount == 1) amp。 (ucRetCode == 1)){ if (ucStatus == 39。語(yǔ)句塊的“{”“}”配對(duì)對(duì)齊，并與其前一行對(duì)齊?！　?/ 函數(shù)foo 與FOO容易混淆　　void TMP_FOO(float fX)。應(yīng)改為有意義的單詞命名define EXAMPLE_UNIT_TESTdefine EXAMPLE_ASSERT_TESTvoid TMP_SetUdtMsgSls(uchar ucSls )。標(biāo)識(shí)符的長(zhǎng)度應(yīng)當(dāng)符合“minlength amp。例如：uchar aucSendBuff[10]。修改信息：修改者名稱(chēng)，修改日期，修改后版本號(hào)，修改內(nèi)容描述。頭文件引用區(qū)主要包含：系統(tǒng)頭文件引用：文件名包含在尖括號(hào)中。軟件設(shè)計(jì)規(guī)范制定： 審核： 批準(zhǔn)： 文件編號(hào)生效日期版本號(hào)分發(fā)部門(mén) 修 訂 履 歷序號(hào) 版本修訂內(nèi)容 修訂人修訂日期會(huì)簽與文件發(fā)放：會(huì)簽部門(mén) 會(huì)簽人會(huì)簽日期簽收部門(mén)簽收人簽收日期 深圳市德卡科技有限公司文件編號(hào)文件版本A1生效日期軟件設(shè)計(jì)規(guī)范發(fā)行類(lèi)別■新增 □修訂發(fā)行部門(mén)研發(fā)中心目 錄第一章、項(xiàng)目模塊劃分 15一、模塊劃分 15二、模塊命名 15第二章、文件格式 15一、c文件格式說(shuō)明： 16文件創(chuàng)建及修改說(shuō)明區(qū) 16頭文件引用區(qū) 16全局變量定義區(qū) 16驅(qū)動(dòng)函數(shù)區(qū) 16應(yīng)用函數(shù)區(qū) 17文件結(jié)束說(shuō)明 17二、h文件格式說(shuō)明 17文件創(chuàng)建及修改說(shuō)明區(qū) 17防重調(diào)用定義 18頭文件引用 18控制接口定義區(qū) 18常量定義區(qū) 19宏調(diào)用定義區(qū) 19類(lèi)型定義區(qū) 19外部引用變量區(qū) 19外部引用函數(shù)區(qū) 20操作流程說(shuō)明區(qū) 201文件結(jié)束說(shuō)明 20第三章、命名規(guī)則 21一、函數(shù)命名規(guī)則 21二、變量命名規(guī)則 21三、宏命名規(guī)則 22四、文件命名規(guī)則 22五、新定義變量類(lèi)型命名規(guī)則 22六、命名注意事項(xiàng)： 22標(biāo)識(shí)符命名基本原則 23命名中若使用特殊約定或縮寫(xiě)，則要有注釋說(shuō)明 23局部循環(huán)變量也必須按照變量命名規(guī)則來(lái)定義 23不要用數(shù)字或較奇怪的字符來(lái)定義標(biāo)識(shí)符 23用正確的反義詞組命名具有互斥意義的變量或相反動(dòng)作的函數(shù)等 23避免使用以下劃線開(kāi)始和結(jié)尾的定義 23程序中不要出現(xiàn)僅靠大小寫(xiě)區(qū)分的相似的標(biāo)識(shí)符 23標(biāo)識(shí)符縮寫(xiě) 24函數(shù)名應(yīng)準(zhǔn)確描述函數(shù)的功能 24避免使用無(wú)意義或含義不清的動(dòng)詞為函數(shù)命名 24第四章、代碼書(shū)寫(xiě)規(guī)范 24一、基本原則 24二、排版 24縮進(jìn)風(fēng)格 24不要使用【TAB】鍵 24空行 24語(yǔ)句長(zhǎng)度要小于80個(gè)字符 25長(zhǎng)語(yǔ)句換行 25長(zhǎng)表達(dá)式換行 26若函數(shù)的參數(shù)較長(zhǎng)，則要進(jìn)行適當(dāng)?shù)膭澐?26一行只寫(xiě)一條語(yǔ)句 26括號(hào){} 27語(yǔ)句縮進(jìn)要求 271分界符 281空格 29三、注釋 30注釋量 30函數(shù)頭部注釋 30代碼與注釋同時(shí)修改 31注釋的內(nèi)容要清楚、明了，含義準(zhǔn)確，防止注釋二義性 31避免在注釋中使用縮寫(xiě)，特別是非常用縮寫(xiě) 31注釋書(shū)寫(xiě)位置 31變量、常量命名不能充分自注釋的，必須加以注釋 32數(shù)據(jù)結(jié)構(gòu)命名不能充分自注釋的，必須加以注釋 32全局變量注釋 32注釋要與說(shuō)描述的內(nèi)容進(jìn)行同樣的縮排 321將注釋與其上面的代碼用空行隔開(kāi) 331連續(xù)case語(yǔ)句處理時(shí)，必須編寫(xiě)注釋 341代碼或表達(dá)式的中間禁止插入注釋 361通過(guò)正確命名使代碼成為自注釋的 361在代碼的功能、意圖層次上進(jìn)行注釋?zhuān)峁┯杏?、額外的信息 361在程序塊的結(jié)束行右方加注釋標(biāo)記，以表明某程序塊的結(jié)束 361注釋格式 371采用中文注釋 371使用 if0和 endif注釋代碼塊 37注釋不能嵌套 37四、代碼可讀性 37使用小括號(hào)明確表達(dá)式的操作順序 37用有意義的枚舉和宏替代數(shù)字 38源程序中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰 39用多行簡(jiǎn)單語(yǔ)句替代復(fù)雜語(yǔ)句 39五、變量，結(jié)構(gòu) 40公共變量 去掉沒(méi)必要的公共變量 仔細(xì)定義并明確公共變量的含義、作用、取值范圍及公共變量間的關(guān)系 明確公共變量與操作此公共變量的函數(shù)或過(guò)程的關(guān)系 要謹(jǐn)慎向公共變量傳遞數(shù)據(jù) 防止局部變量與公共變量同名?？蓞⒖寄K《》說(shuō)明：與硬件相關(guān)的文件可以在此增加說(shuō)明，如芯片型號(hào)等。創(chuàng)建信息：創(chuàng)建者名稱(chēng)，創(chuàng)建日期，最初版本號(hào)，文檔內(nèi)容描述。 表示無(wú)符號(hào)類(lèi)型，當(dāng)前值數(shù)組變量命名時(shí)在局部變量類(lèi)型前增加前綴字母“a”。盡量采用英文命名，不可以用漢語(yǔ)拼音。define EXAMPLE_0_TESTdefine EXAMPLE_1_TESTvoid TMP_SetSls00( ucha