【正文】 // program code } /* end of while (index MAX_INDEX) */ //指明該條while語句結束} /* end of if (...)*/ // 指明是哪條if語句結束1注釋格式語句、變量定義、宏定義注釋使用“//……”格式語句塊、函數(shù)說明使用“/* …… */”格式。 //if mtp receive a message from links if (receive_flag)1在程序塊的結束行右方加注釋標記，以表明某程序塊的結束說明：當代碼段較長，特別是多重嵌套時，這樣做可以使代碼更清晰，更便于閱讀。示例：如下注釋意義不大。1通過正確命名使代碼成為自注釋的通過對函數(shù)或過程、變量、結構等正確的命名以及合理地組織代碼的結構，使代碼成為自注釋的。 break。 break。 break。 break。}else{ProcessCFW_B()。case CMD_FWD: ProcessFwd()。case CMD_DOWN: ProcessDown()。示例（注意斜體加粗部分）：case CMD_UP: ProcessUp()。//code one ments */program code one//code two mentsprogram code two應如下書寫：//code one mentsprogram code one//code two mentsprogram code two1連續(xù)case語句處理時，必須編寫注釋對于switch語句下的case語句，如果因為特殊情況需要處理完一個case后進入下一個case處理，必須在該case語句處理完、下一個case語句前加上明確的注釋。void example_fun( void ){//code one ments CodeBlock One // code two ments CodeBlock Two}應改為如下布局。注釋要與說描述的內容進行同樣的縮排說明：可使程序排版整齊，并方便注釋的閱讀與理解。s unit data transmission request}。 示例：可按如下形式說明枚舉/數(shù)據(jù)/聯(lián)合結構。 示例：//active statistic task number define MAX_ACT_TASK_NUMBER 1000define MAX_ACT_TASK_NUMBER 1000 //active statistic task number數(shù)據(jù)結構命名不能充分自注釋的，必須加以注釋數(shù)據(jù)結構聲明(包括數(shù)組、結構、類、枚舉等)，如果其命名不是充分自注釋的，必須加以注釋。變量、常量命名不能充分自注釋的，必須加以注釋對于所有有物理含義的變量、常量，如果其命名不是充分自注釋的，在聲明時都必加注釋，說明其物理含義。//get replicate sub system index and net indicator 應如下書寫//get replicate sub system index and net indicator ucRepssnInd = aucSsnData[ucIndex].ucRepssnIndex。例2：ucRepssnInd = aucSsnData[ucIndex].ucRepssnIndex。例1：//get replicate sub system index and net indicator ucRepssnInd = aucSsnData[ucIndex].ucRepssnIndex。注釋書寫位置注釋應與其描述的代碼相近，對代碼的注釋應放在其上方或右方（對單條語句的注釋）相鄰位置，不可放在下面，如放于上方則需與其上面的代碼用空行隔開。注釋的內容要清楚、明了，含義準確，防止注釋二義性說明：錯誤的注釋不但無益反而有害。代碼與注釋同時修改邊寫代碼邊注釋，修改代碼同時修改相應的注釋，以保證注釋與代碼的一致性。如果函數(shù)有調用全局變量，也要在此 進行詳細說明。函數(shù)功能：該函數(shù)實現(xiàn)的具體功能，具有依賴關系的函數(shù)間在此進行說明。 函數(shù)頭部注釋每個函數(shù)頭部都應該進行注釋，包括函數(shù)實現(xiàn)的功能，參數(shù)說明，返回值等。 (c=d))三、注釋注釋量一般情況下，源程序有效注釋量必須在20％以上。 i++)和if ((a=b) amp。 }(10)、對于表達式比較長的for語句和if語句，為了緊湊起見可以適當?shù)厝サ粢恍┛崭? 例如：for (i=0。 // 指針前后不加空格(9)、指針定義符號*的前面加空格。 // ++,與內容之間(8)、”[]”、.前后不加空格。 // 地址操作amp。 // 非操作!與內容之間p = amp。a39。（地址運算符）等單目操作符前后不加空格。a = b ^ 2。if (current_time = MAX_TIME_VALUE) a = b + c。amp。 condition。(5)、如果‘。’向前緊跟，緊跟處不留空格。(1)、關鍵字之后要留空格，以突出關鍵字。在長語句中，如果需要加的空格非常多，那么應該保持整體清晰，而在局部不加空格。說明：采用這種松散方式編寫代碼的目的是使代碼更加清晰。for (...) { ... // program code}if (...) { ... // program code }void example_fun( void ) { ... // program code }應如下書寫。在函數(shù)體的開始、類的定義、結構的定義、枚舉的定義以及if、for、do、while、switch、case語句中的程序都要采用如上的縮進方式。 endif // Wrong! Do not indent endif BackToNormal()。endifendif BackToNormal()。即使預處理指令位于縮進代碼塊中，指令也應從行首開始 示例：良好風格：預處理指令均從行首開始if (lopsided_score) {if DISASTER_PENDING // Correct Starts at beginning of line DropEverything()。}語句縮進要求函數(shù)的開始、結構的定義及循環(huán)、判斷等語句中的代碼都要采用縮進風格，case語句下的情況處理語句也要遵從語句縮進要求。if (pUserCR == NULL) return。 左大括號“{”后和右大括號“}”前不可出現(xiàn)代碼，并且與引用他的語句左對齊。 = 0。 = 0。 i++, j++){ ... // program code }若函數(shù)的參數(shù)較長，則要進行適當?shù)膭澐忠恍兄粚懸粭l語句不允許把多個短語句寫在一行中，即一行只寫一條語句示例：如下例子不符合規(guī)范。amp。 i++, j++){ ... // program code}for (i=0, j=0。amp。 (TMP_StatItemValid (ucStatItem))){ ... // program code}for (i=0, j=0。示例：if ((ucTaskNo TMP_MAX_TASK_NUMBER) amp。長表達式換行循環(huán)、判斷等語句中若有較長的表達式或語句，則要進行適應的劃分，長表達式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首。 示例： = TMP_TO_STAT_PERM_COUNT_LEN + TMP_STAT_SIZE_PER_FRAM * sizeof( ulong )。}語句長度要小于80個字符 一行語句以小于80字符為宜，不要寫得過長。 (ucRetCode == 0)){ *pucErrCode = EPRONTCENTER。 }}if ((ucCount == 1) amp。) { *pucErrCode = 0。 (ucRetCode == 1)){ if (ucStatus == 39。}應如下書寫：if ((ucCount == 1) amp。 (ucRetCode == 0)){ *pucErrCode = EPRONTCENTER。 }}if ((ucCount == 1) amp。) { *pucErrCode = 0。 (ucRetCode == 1)){ if (ucStatus == 39。if ((ucCount == 1) amp。空行 相對獨立的程序塊之間、變量說明之后必須加空行?？梢圆捎每崭矜I來替代，4個空格代替一個【TAB】鍵。語句塊的“{”“}”配對對齊，并與其前一行對齊。二、排版縮進風格 程序塊要采用縮進風格編寫，縮進的空格數(shù)為4個。所有的代碼必須采用ANSI C，標準函數(shù)原型必須采用ANSI C 標準。常用單詞縮寫見《附錄B 常用單詞及縮寫》函數(shù)名應準確描述函數(shù)的功能避免使用無意義或含義不清的動詞為函數(shù)命名 說明：避免用含義不清的動詞如process、handle等為函數(shù)命名，因為這些動詞并沒有說明要具體做什么?！　?/ 函數(shù)foo 與FOO容易混淆　　void TMP_FOO(float fX)。避免使用以下劃線開始和結尾的定義 除了編譯開關/頭文件等特殊應用，應避免使用_EXAMPLE_TEST_之類以下劃線開始和結尾的定義程序中不要出現(xiàn)僅靠大小寫區(qū)分的相似的標識符 例如：　　uint　uix,　uiX。uint TMP_AddUser( uchar *pucUserName )。示例：uint uiMinSum。應改為有意義的單詞命名define EXAMPLE_UNIT_TESTdefine EXAMPLE_ASSERT_TESTvoid TMP_SetUdtMsgSls(uchar ucSls )。不要用數(shù)字或較奇怪的字符來定義標識符 示例：如下命名，使人產生疑惑。參考《附錄B 常用單詞及縮寫》命名中若使用特殊約定或縮寫，則要有注釋說明說明：應該在源文件的開始之處，對文件中所使用的縮寫或約定，特別是特殊的縮寫，進行必要的注釋說明。 maxinformation”原則。標識符的長度應當符合“minlength amp。六、命名注意事項：標識符命名基本原則標識符的命名要清晰、明了，有明確含義，同時使用完整的單詞或大家基本可以理解的縮寫，避免使人產生誤解。靜態(tài)變量命名時在局部變量類型前增加前綴字母“s”和下劃線。例如：uchar *pucReceiveBuff[10]。例如：uchar aucSendBuff[10]。二、變量命名規(guī)則局部變量命名：格式如下：序號說明字體選擇備注1變量類型簡寫小寫必選以最直觀模式給用戶區(qū)分不同的變量類型，最多2個字母長度，具體參考《附錄A 常用變量類型及簡寫》2變量修飾首字母大寫可選修飾詞英文名稱或者簡寫，最多2個單詞3變量名稱首字母大寫必選名稱英文名稱或者簡寫，最多2個單詞例如：uchar ucCurrentValue?？蓞⒖寄K《》外部引用變量區(qū)主要包含：外部應用變量區(qū)說明注釋行：引用變量聲明：以extern關鍵字開始注釋說明：可參考模塊《》外部引用函數(shù)區(qū)主要包含：外部應用函數(shù)區(qū)說明注釋行：函數(shù)注釋說明：包含函數(shù)功能說明，參數(shù)說明，返回值說明引用函數(shù)聲明：以extern關鍵字開始可參考模塊《》操作流程說明區(qū)主要包含：操作流程說明區(qū)說明注釋行：模塊執(zhí)行流程說明：說明要詳細，執(zhí)行步驟要明確。自定義頭文件引用：文件名包含著雙引號中。修改信息：修改者名稱，修改日期，修改后版本號，修改內容描述。函數(shù)體： 可參考模塊《》文件結束說明主要包含：文件結束說明：End Of File可參考模塊《》二、h文件格式說明文件創(chuàng)建及修改說明區(qū)主要包含：公司信息：公司名稱、公司網站。驅動函數(shù)區(qū)主要包含：驅動函數(shù)區(qū)說明注釋行：函數(shù)說明：包含函數(shù)說明，參數(shù)說明，返回值說明?？蓞⒖寄K《》全局變量定義區(qū)主要包含：全局變量定義區(qū)說明注釋行：全局變量定義：要賦初值。頭文件引用區(qū)主要包含：系統(tǒng)頭文件引用：文件名包含在尖括號中。修改信息：修改者名稱，修改日期，修改后版本號，修改內容描述。例如：模塊命名說明液晶 液晶初始化，字符、漢字和圖片顯示 液晶自定義字庫按鍵 按