【正文】 9外部引用函數(shù)區(qū) 20操作流程說明區(qū) 201文件結束說明 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避免使用以下劃線開始和結尾的定義 23程序中不要出現(xiàn)僅靠大小寫區(qū)分的相似的標識符 23標識符縮寫 24函數(shù)名應準確描述函數(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注釋的內容要清楚、明了，含義準確，防止注釋二義性 31避免在注釋中使用縮寫，特別是非常用縮寫 31注釋書寫位置 31變量、常量命名不能充分自注釋的，必須加以注釋 32數(shù)據(jù)結構命名不能充分自注釋的，必須加以注釋 32全局變量注釋 32注釋要與說描述的內容進行同樣的縮排 321將注釋與其上面的代碼用空行隔開 331連續(xù)case語句處理時，必須編寫注釋 341代碼或表達式的中間禁止插入注釋 361通過正確命名使代碼成為自注釋的 361在代碼的功能、意圖層次上進行注釋，提供有用、額外的信息 361在程序塊的結束行右方加注釋標記，以表明某程序塊的結束 361注釋格式 371采用中文注釋 371使用 if0和 endif注釋代碼塊 37注釋不能嵌套 37四、代碼可讀性 37使用小括號明確表達式的操作順序 37用有意義的枚舉和宏替代數(shù)字 38源程序中關系較為緊密的代碼應盡可能相鄰 39用多行簡單語句替代復雜語句 39五、變量，結構 40公共變量 去掉沒必要的公共變量 仔細定義并明確公共變量的含義、作用、取值范圍及公共變量間的關系 明確公共變量與操作此公共變量的函數(shù)或過程的關系 要謹慎向公共變量傳遞數(shù)據(jù) 防止局部變量與公共變量同名。例如：模塊命名說明液晶 液晶初始化，字符、漢字和圖片顯示 液晶自定義字庫按鍵 按鍵初始化，鍵值列表，取按鍵值指示燈 指示燈初始化，閃爍控制數(shù)碼管數(shù)碼管初始化，數(shù)字顯示，特殊字符顯示蜂鳴器蜂鳴器初始化，鳴叫控制第二章、文件格式一、c文件格式說明：文件創(chuàng)建及修改說明區(qū)主要包含：公司信息：公司名稱、公司網(wǎng)站。頭文件引用區(qū)主要包含：系統(tǒng)頭文件引用：文件名包含在尖括號中。驅動函數(shù)區(qū)主要包含：驅動函數(shù)區(qū)說明注釋行：函數(shù)說明：包含函數(shù)說明，參數(shù)說明，返回值說明。修改信息：修改者名稱，修改日期，修改后版本號，修改內容描述。可參考模塊《》外部引用變量區(qū)主要包含：外部應用變量區(qū)說明注釋行：引用變量聲明：以extern關鍵字開始注釋說明：可參考模塊《》外部引用函數(shù)區(qū)主要包含：外部應用函數(shù)區(qū)說明注釋行：函數(shù)注釋說明：包含函數(shù)功能說明，參數(shù)說明，返回值說明引用函數(shù)聲明：以extern關鍵字開始可參考模塊《》操作流程說明區(qū)主要包含：操作流程說明區(qū)說明注釋行：模塊執(zhí)行流程說明：說明要詳細，執(zhí)行步驟要明確。例如：uchar aucSendBuff[10]。靜態(tài)變量命名時在局部變量類型前增加前綴字母“s”和下劃線。標識符的長度應當符合“minlength amp。參考《附錄B 常用單詞及縮寫》命名中若使用特殊約定或縮寫，則要有注釋說明說明：應該在源文件的開始之處，對文件中所使用的縮寫或約定，特別是特殊的縮寫，進行必要的注釋說明。應改為有意義的單詞命名define EXAMPLE_UNIT_TESTdefine EXAMPLE_ASSERT_TESTvoid TMP_SetUdtMsgSls(uchar ucSls )。uint TMP_AddUser( uchar *pucUserName )?！　?/ 函數(shù)foo 與FOO容易混淆　　void TMP_FOO(float fX)。所有的代碼必須采用ANSI C，標準函數(shù)原型必須采用ANSI C 標準。語句塊的“{”“}”配對對齊，并與其前一行對齊。空行 相對獨立的程序塊之間、變量說明之后必須加空行。 (ucRetCode == 1)){ if (ucStatus == 39。 }}if ((ucCount == 1) amp。}應如下書寫：if ((ucCount == 1) amp。) { *pucErrCode = 0。 (ucRetCode == 0)){ *pucErrCode = EPRONTCENTER。 示例： = TMP_TO_STAT_PERM_COUNT_LEN + TMP_STAT_SIZE_PER_FRAM * sizeof( ulong )。示例：if ((ucTaskNo TMP_MAX_TASK_NUMBER) amp。amp。amp。 = 0。 左大括號“{”后和右大括號“}”前不可出現(xiàn)代碼，并且與引用他的語句左對齊。}語句縮進要求函數(shù)的開始、結構的定義及循環(huán)、判斷等語句中的代碼都要采用縮進風格，case語句下的情況處理語句也要遵從語句縮進要求。endifendif BackToNormal()。在函數(shù)體的開始、類的定義、結構的定義、枚舉的定義以及if、for、do、while、switch、case語句中的程序都要采用如上的縮進方式。說明：采用這種松散方式編寫代碼的目的是使代碼更加清晰。(1)、關鍵字之后要留空格，以突出關鍵字。(5)、如果‘。amp。a = b ^ 2。a39。 // 地址操作amp。 // 指針前后不加空格(9)、指針定義符號*的前面加空格。 i++)和if ((a=b) amp。 函數(shù)頭部注釋每個函數(shù)頭部都應該進行注釋，包括函數(shù)實現(xiàn)的功能，參數(shù)說明，返回值等。如果函數(shù)有調用全局變量，也要在此 進行詳細說明。注釋的內容要清楚、明了，含義準確，防止注釋二義性說明：錯誤的注釋不但無益反而有害。例1：//get replicate sub system index and net indicator ucRepssnInd = aucSsnData[ucIndex].ucRepssnIndex。//get replicate sub system index and net indicator 應如下書寫//get replicate sub system index and net indicator ucRepssnInd = aucSsnData[ucIndex].ucRepssnIndex。 示例：//active statistic task number define MAX_ACT_TASK_NUMBER 1000define MAX_ACT_TASK_NUMBER 1000 //active statistic task number數(shù)據(jù)結構命名不能充分自注釋的，必須加以注釋數(shù)據(jù)結構聲明(包括數(shù)組、結構、類、枚舉等)，如果其命名不是充分自注釋的，必須加以注釋。s unit data transmission request}。void example_fun( void ){//code one ments CodeBlock One // code two ments CodeBlock Two}應改為如下布局。示例（注意斜體加粗部分）：case CMD_UP: ProcessUp()。case CMD_FWD: ProcessFwd()。 break。 break。1通過正確命名使代碼成為自注釋的通過對函數(shù)或過程、變量、結構等正確的命名以及合理地組織代碼的結構，使代碼成為自注釋的。 //if mtp receive a message from links if (receive_flag)1在程序塊的結束行右方加注釋標記，以表明某程序塊的結束說明：當代碼段較長，特別是多重嵌套時，這樣做可以使代碼更清晰，更便于閱讀。說明：注釋語言不統(tǒng)一，影響程序易讀性和外觀排版，出于對維護人員的考慮，建議使用中文。示例：下列語句中的表達式word = (high 8) | low (1)if ((a | b) amp。 d)) (3)如果書寫為high 8 | lowa | b amp。 d由于high 8 | low = ( high 8) | low,a | b amp。amp。 d，(3)造成了判斷條件出錯。if (Trunk[index].trunk_state == 0){ Trunk[index].trunk_state = 1。 = 10。 = 10。用多行簡單語句替代復雜語句不要使用難懂的技巧性很高的語句，除非很有必要時。* ++ stat_poi += 1。 // 此二語句功能相當于“ * stat_poi ++ += 1。五、變量，結構 公共變量、去掉沒必要的公共變量說明：公共變量是增大模塊間耦合的原因之一，故應減少沒必要的公共變量以降低模塊間的耦合度。這種關系的說明可在注釋或文檔中描述。、要謹慎向公共變量傳遞數(shù)據(jù) 當向公共變量傳遞數(shù)據(jù)時，要十分小心，防止賦與不合理的值或越界等現(xiàn)象發(fā)生。、公共變量僅由模塊或函數(shù)創(chuàng)建和修改，其余模塊和函數(shù)只能訪問構造僅有一個模塊或函數(shù)可以修改、創(chuàng)建，而其余有關模塊或函數(shù)只訪問的公共變量，防止多個不同模塊或函數(shù)都可以修改、創(chuàng)建同一公共變量的現(xiàn)象。說明：使用標準的數(shù)據(jù)類型，有利于程序的移植。 int　length, width；int i, j, k。數(shù)組、數(shù)組大小及初始值要明確定義 數(shù)組初始化不要采用系統(tǒng)默認值，最好能夠采用初始化語句來完成、數(shù)組、結構和聯(lián)合的初始化列表應顯式描述 數(shù)組、結構和聯(lián)合的初始化列表應使用大括號，并使用附加的大括號來指示嵌套的結構；程序員應顯式地考慮和描述復雜數(shù)據(jù)類型的所有元素，不應忽略某個元素的初始化。結構中的各元素應代表同一事務的不同側面，而不應把描述沒有關系或關系很弱的不同事務的元素放到同一結構中。s name unsigned char ucAge。s sex, as follows // 0 FEMALE。 // his teacher sex } STUDENT。 // teacher sex, as follows // 0 FEMALE。s name unsigned char ucAge。s sex, as follows // 0 FEMALE。、不同結構間的關系不要過于復雜說明：若兩個結構間關系較復雜、密切，那么應合為一個結構。 unsigned char ucSex。 unsigned char ucAge。typedef struct PERSON_STRU{ unsigned char aucName[8]。 unsigned char aucCity[15]。說明：增加結構的可理解性、可操作性和可維護性。 unsigned char ucSex。 unsigned char ucTel。} PERSON。typedef struct EXAMPLE_STRU{ unsigned int uiValid: 1。若改成如下形式，不僅可節(jié)省1字節(jié)空間，可讀性也變好了。} EXAMPLE。、跨平臺數(shù)據(jù)結構，要考慮字節(jié)順序及對齊問題當聲明用于分布式環(huán)境或不同CPU間通信環(huán)境的數(shù)據(jù)結構時，必須考慮機器的字節(jié)順序、使用的位域及字節(jié)對齊等問題 。typedef struct EXAM_BIT_STRU{ /* Intel 68360 */ unsigned int A1: 1。如下是Intel CPU生成短整數(shù)及位域的方式。