【正文】 st pucSecond。uiTemp。 uchar *pucFirst, *pucSecond。 正確用法示例 uint *puiPoint。、應(yīng)禁止 signed 類型與 unsigned 類型之間的隱式轉(zhuǎn)化從有符號類型轉(zhuǎn)換為無符號類型會導致符號的丟失。下面的聲明可使數(shù)據(jù)類型的使用簡潔、明了。unsigned short int exam。示例：如下結(jié)構(gòu)中的位域排列，將占較大空間，可讀性也稍差。、結(jié)構(gòu)中元素的個數(shù)應(yīng)適中若結(jié)構(gòu)中元素個數(shù)過多可考慮依據(jù)某種原則把元素組成不同的子結(jié)構(gòu)，以減少原結(jié)構(gòu)中元素的個數(shù)。 unsigned char aucAddr[40]。 // teacher name unisgned char ucSex。 正確用法：int16_t y[3][2] = { { 1, 2 }, { 3, 4 }, { 5結(jié)構(gòu)、聯(lián)合、結(jié)構(gòu)的功能要單一，是針對一種事務(wù)的抽象說明：設(shè)計結(jié)構(gòu)時應(yīng)力爭使結(jié)構(gòu)代表一種現(xiàn)實事務(wù)的抽象，而不是同時代表多種。說明：若使用了較好的命名規(guī)則，那么此問題可自動消除。stat_poi++。示例：以下代碼布局不太合理。 ca | b c amp。//if receive_flag is TRUE if (receive_flag)而如下的注釋則給出了額外有用的信息。 break。變量、常量、宏的注釋應(yīng)放在其上方相鄰位置或右方。參數(shù)：如果參數(shù)值為已知，可以在此詳細列表說明。mem。(4)、‘,’之后要留空格，例如：Function(x, y, z)。if NOTIFY NotifyClient()。 (i usFirstWordLength) amp。amp。amp。　　　　 // 變量x 與 X 容易混淆　　void TMP_foo(uint uiX)。盡量采用英文命名，不可以用漢語拼音。創(chuàng)建信息：創(chuàng)建者名稱，創(chuàng)建日期，最初版本號，文檔內(nèi)容描述。軟件設(shè)計規(guī)范制定： 審核： 批準： 文件編號生效日期版本號分發(fā)部門 修 訂 履 歷序號 版本修訂內(nèi)容 修訂人修訂日期會簽與文件發(fā)放：會簽部門 會簽人會簽日期簽收部門簽收人簽收日期 深圳市德卡科技有限公司文件編號文件版本A1生效日期軟件設(shè)計規(guī)范發(fā)行類別■新增 □修訂發(fā)行部門研發(fā)中心目 錄第一章、項目模塊劃分 15一、模塊劃分 15二、模塊命名 15第二章、文件格式 15一、c文件格式說明： 16文件創(chuàng)建及修改說明區(qū) 16頭文件引用區(qū) 16全局變量定義區(qū) 16驅(qū)動函數(shù)區(qū) 16應(yīng)用函數(shù)區(qū) 17文件結(jié)束說明 17二、h文件格式說明 17文件創(chuàng)建及修改說明區(qū) 17防重調(diào)用定義 18頭文件引用 18控制接口定義區(qū) 18常量定義區(qū) 19宏調(diào)用定義區(qū) 19類型定義區(qū) 19外部引用變量區(qū) 19外部引用函數(shù)區(qū) 20操作流程說明區(qū) 201文件結(jié)束說明 20第三章、命名規(guī)則 21一、函數(shù)命名規(guī)則 21二、變量命名規(guī)則 21三、宏命名規(guī)則 22四、文件命名規(guī)則 22五、新定義變量類型命名規(guī)則 22六、命名注意事項： 22標識符命名基本原則 23命名中若使用特殊約定或縮寫，則要有注釋說明 23局部循環(huán)變量也必須按照變量命名規(guī)則來定義 23不要用數(shù)字或較奇怪的字符來定義標識符 23用正確的反義詞組命名具有互斥意義的變量或相反動作的函數(shù)等 23避免使用以下劃線開始和結(jié)尾的定義 23程序中不要出現(xiàn)僅靠大小寫區(qū)分的相似的標識符 23標識符縮寫 24函數(shù)名應(yīng)準確描述函數(shù)的功能 24避免使用無意義或含義不清的動詞為函數(shù)命名 24第四章、代碼書寫規(guī)范 24一、基本原則 24二、排版 24縮進風格 24不要使用【TAB】鍵 24空行 24語句長度要小于80個字符 25長語句換行 25長表達式換行 26若函數(shù)的參數(shù)較長，則要進行適當?shù)膭澐?26一行只寫一條語句 26括號{} 27語句縮進要求 271分界符 281空格 29三、注釋 30注釋量 30函數(shù)頭部注釋 30代碼與注釋同時修改 31注釋的內(nèi)容要清楚、明了，含義準確，防止注釋二義性 31避免在注釋中使用縮寫，特別是非常用縮寫 31注釋書寫位置 31變量、常量命名不能充分自注釋的，必須加以注釋 32數(shù)據(jù)結(jié)構(gòu)命名不能充分自注釋的，必須加以注釋 32全局變量注釋 32注釋要與說描述的內(nèi)容進行同樣的縮排 321將注釋與其上面的代碼用空行隔開 331連續(xù)case語句處理時，必須編寫注釋 341代碼或表達式的中間禁止插入注釋 361通過正確命名使代碼成為自注釋的 361在代碼的功能、意圖層次上進行注釋，提供有用、額外的信息 361在程序塊的結(jié)束行右方加注釋標記，以表明某程序塊的結(jié)束 361注釋格式 371采用中文注釋 371使用 if0和 endif注釋代碼塊 37注釋不能嵌套 37四、代碼可讀性 37使用小括號明確表達式的操作順序 37用有意義的枚舉和宏替代數(shù)字 38源程序中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰 39用多行簡單語句替代復雜語句 39五、變量，結(jié)構(gòu) 40公共變量 去掉沒必要的公共變量 仔細定義并明確公共變量的含義、作用、取值范圍及公共變量間的關(guān)系 明確公共變量與操作此公共變量的函數(shù)或過程的關(guān)系 要謹慎向公共變量傳遞數(shù)據(jù) 防止局部變量與公共變量同名。修改信息：修改者名稱，修改日期，修改后版本號，修改內(nèi)容描述。標識符的長度應(yīng)當符合“minlength amp?！　?/ 函數(shù)foo 與FOO容易混淆　　void TMP_FOO(float fX)。 (ucRetCode == 1)){ if (ucStatus == 39。 (ucRetCode == 0)){ *pucErrCode = EPRONTCENTER。amp。endifendif BackToNormal()。(5)、如果‘。 // 地址操作amp。如果函數(shù)有調(diào)用全局變量，也要在此 進行詳細說明。 示例：//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)、類、枚舉等)，如果其命名不是充分自注釋的，必須加以注釋。case CMD_FWD: ProcessFwd()。 //if mtp receive a message from links if (receive_flag)1在程序塊的結(jié)束行右方加注釋標記，以表明某程序塊的結(jié)束說明：當代碼段較長，特別是多重嵌套時，這樣做可以使代碼更清晰，更便于閱讀。 d由于high 8 | low = ( high 8) | low,a | b amp。 = 10。 // 此二語句功能相當于“ * stat_poi ++ += 1。、公共變量僅由模塊或函數(shù)創(chuàng)建和修改，其余模塊和函數(shù)只能訪問構(gòu)造僅有一個模塊或函數(shù)可以修改、創(chuàng)建，而其余有關(guān)模塊或函數(shù)只訪問的公共變量，防止多個不同模塊或函數(shù)都可以修改、創(chuàng)建同一公共變量的現(xiàn)象。結(jié)構(gòu)中的各元素應(yīng)代表同一事務(wù)的不同側(cè)面，而不應(yīng)把描述沒有關(guān)系或關(guān)系很弱的不同事務(wù)的元素放到同一結(jié)構(gòu)中。 // teacher sex, as follows // 0 FEMALE。 unsigned char ucSex。說明：增加結(jié)構(gòu)的可理解性、可操作性和可維護性。typedef struct EXAMPLE_STRU{ unsigned int uiValid: 1。typedef struct EXAM_BIT_STRU{ /* Intel 68360 */ unsigned int A1: 1。typedef unsigned char BYTE。無符號數(shù)轉(zhuǎn)換為有符號數(shù)，可能得到一個負值。 uint auiPointTmp[10]。 uint uiTemp。 return。 pucSecond = aucArray + 2。 puiPoint = puiPoint + 2。指針、不應(yīng)對指針變量使用強制類型轉(zhuǎn)換賦值、不應(yīng)把自動類型的局部變量的地址賦值給外部指針局部變量的地址賦值給外部或者范圍更大的指針，如果局部變量不是靜態(tài)的，那么這種用法是不安全的。typedef unsigned int DWORD。 /* bit 1 6 */ unsigned int A3: 1。 unsigned int uiSetFlg: 1。typedef struct PERSON_BASE_INFO_STRU{ unsigned char ucName[8]。} PERSON_ONE。typedef struct STUDENT_STRU{ unsigned char aucName[8]。typedef struct STUDENT_STRU{ unsigned char aucName[8]。局部變量、嚴禁使用未經(jīng)初始化的變量作為右值說明：特別是在C/C++中引用未經(jīng)賦值的指針，經(jīng)常會引起系統(tǒng)崩潰。*stat_poi += 1。 = 5。 a amp。if (...){ // program code while (index MAX_INDEX) { // program code } /* end of while (index MAX_INDEX) */ //指明該條while語句結(jié)束} /* end of if (...)*/ // 指明是哪條if語句結(jié)束1注釋格式語句、變量定義、宏定義注釋使用“//……”格式語句塊、函數(shù)說明使用“/* …… */”格式。}else{ProcessCFW_B()。 示例：可按如下形式說明枚舉/數(shù)據(jù)/聯(lián)合結(jié)構(gòu)。代碼與注釋同時修改邊寫代碼邊注釋，修改代碼同時修改相應(yīng)的注釋，以保證注釋與代碼的一致性。 // ++,與內(nèi)容之間(8)、”[]”、.前后不加空格。 condition。 endif // Wrong! Do not indent endif BackToNormal()。 i++, j++){ ... // program code }若函數(shù)的參數(shù)較長，則要進行適當?shù)膭澐忠恍兄粚懸粭l語句不允許把多個短語句寫在一行中，即一行只寫一條語句示例：如下例子不符合規(guī)范。}語句長度要小于80個字符 一行語句以小于80字符為宜，不要寫得過長。) { *pucErrCode = 0。常用單詞縮寫見《附錄B 常用單詞及縮寫》函數(shù)名應(yīng)準確描述函數(shù)的功能避免使用無意義或含義不清的動詞為函數(shù)命名 說明：避免用含義不清的動詞如process、handle等為函數(shù)命名，因為這些動詞并沒有說明要具體做什么。 maxinformation”原則。自定義頭文件引用：文件名包含著雙