1、C語后編碼標準關于命名標準1對命名的一般方針1） 進行命名的時候在充分把握對象數據變量、函數、etc的內容的根底上,再進行能明確顯示其內容的名命名.2） 要實行不需要注釋的命名3命名滿足不了上述1、2條件的時候,是否是以多意使用其變量、很可能是函數分割的不充分.進行上述的修改之后,試試再次進行命名.4不限制單詞數5各單詞的開頭用大寫字母,并以此作為文字區分符.6單詞晝選擇容易明白的單純的英語單詞.7） 不要省略必要的前置詞.8） 禁止只以大寫字母/不寫字母的不同來區別命名.9） C語言習慣使用的單詞可以就那樣使用.10命名時不要使用C語言的保存字.11禁止在數據的一局部插入數字區別數據10）

2、遵照對命名的方針的命名例子采用經常被使用的表現形式,舉一個根據英語命名的具體例子1） 動詞+目標字或目標字+動詞的過去分詞2） 前置詞from'的使用方法3)的4在內,做3關于單詞的省略1規定1積極使用省略詞詞典編目過的省略詞.規定2制作省略詞詞典中未編目歧視的省略詞,要遵照以下規定：省略以前單詞不滿6個字的不省略.RoagRdx不進行只有一個字的省略.BMWtBW父省略詞最短的長度為3個字.但經常被使用的省略詞TV、CD、etc除外.規定3制作省略詞詞典未編目的省略詞時,遵照以下的順序.有一般的省略詞時,使用一般的省略詞.取消不必要的后綴以最初的第1、第2音節作為省略詞但是,如果能夠

3、料想到相同省略詞經常發生的時候,不要采用這種方法.消除在單詞開頭的元音以外的元音.以上方法不一定同時采用,總之,要選擇適宜的方法制作易懂的省略詞.規定4對于以多個單詞表示一個意思的詞匯,可以以各個單詞的打頭字作為省略詞.這時候,打頭字要全部為大寫exUnitBulletinBoardtUBB規定5對于以多個單詞表示一個意思的詞匯,可以以各個單詞的打頭字和其他的單詞或其他單詞的省略詞作為省略詞.這時,省略詞的打頭字以及文字區分符都要大寫.exVicsData-Vdata規定6把新制作的所有的省略詞編錄到省略詞詞典上.2根據省略詞制作的規定制作的省略詞的例子,參照另外的省略詞詞典.4對變量/函數的

4、命名規定1變更名要在20個字以內,函數名要在30個字以內.2變量/函數名的構成要素為范圍限定符一+型+標識符3對在多個源文件之間共同使用的全程變量/函數付與范圍限定符、對只在單一源文件內使用的局部變量/函數付與不付與都可以.4范圍限定符是23個字符的小寫字母.使用登記在各組的范圍限定符.5型使用以下字母.6型是小寫字母.7指針、數組的接頭詞各自使用p''a'8含指針、類型的變量/函數名的命名方法遵照以下規單.對排列的指示字pointertoarray范圍限定符+pa+型+標識符標識符的排歹Uarrayofpointer范圍限定符+ap+型+標識符9關于用戶定義型原那么上

5、不定義型名比方說,單獨制作了為OriginaData名的int型的用戶定義型時,對變量名附加了表示原來型名的I成為I-*'.但是關于在軟件技術部全體共同使用的用戶定義的型,應該一并治理,制作共同使用的型名的接頭詞.10標識符最低含一個名詞.關于源文件整體的標準1源文件的構成1源文件的全體構成為以下內容只是根據源文件,有時不存在相應的段.源文件的注釋框包含文件局部宏定義局部型定義局部構造體定義局部綜合變量定義局部文件static變量定義局部原型說明定義調試開關定義局部函數定義局部2一個源文件的最大行數為800行.3源文件中行中的語句的最大文字數為120.4文件內一個標記為4個半角空格.另

6、外,以匯編程序編程時,一個標記也要盡量為4個半角空格,必須為8個半角空格時,也要以4個半角空格為1個標記,分為2個標記.2源文件內函數的配置1） 在一個源文件內,從相同文件內的哪個函數都調不出的最上層的函數全局函數只定義一個.但是,小的全局函數并列構成的任務例：mode的key處理等或在4章中.2） 表達的共同函數文件不適用這個標準.3） 一個源文件內函數定義的順序以最上層的函數為打頭,按以后進行處理的順序定義.4） 在一個函數內,從多個函數調出的共同函數,在相同源文件的末尾整理定義.5在多個源文件的調出的共同函數,根據功能整理,制作只定義共同函數的共同函數文件函數.但是,共同函數有很多,一個

7、源文件歸納不了時,根據功能分為幾個源文件.3對源文件的注釋框源文件注釋框根據以下的例子,記敘所有的工程.適當的記敘工程沒有時,記述為“無.注釋英語、日語都可以.對各種說明、定義的標準1制作包含文件的規定1包含文件名全部用小寫字母命名.2包含文件由以下工程構成,除以下工程外不寫其它工程.但沒必要寫以下全部工程.包含文件用注解框必須寫宏定義沒有時可省略型說明沒有時可省略A_AA_&構造體說明沒有時可省略函數保存說明沒有時可省略extern說明沒有時可省略3在注解框上寫在讀取該包含文件前需要讀取的包含文件.4包含文件內的定義、說明可在多個源文件內使用.5包含文件內各種數據的定義、說明格式按源

8、文件的標準.6包含文件內希望不包含其他文件.2 在包含文件內進行定義的mask常數/狀態常數的規定1） 進彳tflag等bitdata的mask的常數以后叫mask常數和表示bit狀態的常數以后叫狀態常數必須在包含文件內進行宏定義.2） mask常數和狀態常數對于用戶定義的bit必須按組定義.而且,不管使不使用也一起定義相反的mask常數和狀態常數.但是對于從CD-ROM讀入的數據中的bit,只定義mask常數即可.3只有一個mask常數用直接值定義.和它有關聯的各種常數用邏輯式進行定義如用于檢測它的狀態和相反狀態的mask常數、根據該mask常數應測出的狀態常數等.4和mask常數、狀態常數

9、一起定義mask運算對象的變量以后叫靜態變量和bit寬.5mask常數的命名規那么在名字的最后加“_MASK取靜太變量和邏輯語時測出上述狀態以外所有狀態的mask常數,在上述mask常數前力口“NOT"NOT_狀態MASK不能在mask常數名中加表示bit位置的數據_2bit_MASK.為測出一個狀態定義一個mask常數.不能把用一個mask常數測出多個狀態作為目的.對mask常數不能進行明確表示應測出的狀態的命名時,有可能為測出多個狀態而進行mask常數定義.這時按各自目的分開討論.6狀態常數的命名規那么定義根據和上邊命名的一個mask常數的邏輯運算應測出的表示一個狀態的狀態常數不

10、能把多個狀態用一個狀態常數表示.對于一個狀態常數定義一個表示取反狀態的狀態常數時,為了明確表示它們是互相取反狀態,在狀態常數名前加“NOT.3 包含文件內的屏蔽定數/狀態定數定義的例子反例在源文件中記錄下的編碼正例在unde中記錄以下的編碼4 關于源文件中包含文件節的格式的規定1） 在一個源文件中使用的包含文件全部以“包含文件節包含.但是,函數的extern說明被保存的包含文件要以全局函數的extern說明節包含.2在“包含文件節的標題要設有表示節開始的注釋框.3把包含文件節分割為以下的種類：C語言標準的頭文件E1系統共同的頭文件任務組共同的頭文件模型共同的頭文件任務共同的頭文件4定義歸納為各

11、個種類進行,并在各個種類的段落上附加說明以及空格行.5各個各類定義的順序按以上的順序.6對E1系統共同的頭文件以下付與顯示其使用目的的注釋.7） “#include全部用小寫字母記述.8） 展開的個組文件的標題要對劉到同一列上.5宏定義和預處理器命名格式的規定1在多個源文件上使用的宏全部包含文件內定義.根據處理標準決定保存在哪一層.2在一個源文件內使用或在一個函數內使用的宏癸源文件內的“宏定義section上定義.3在“宏定義section的開頭設一個明確setion開始的注解框.4關聯性強的宏歸納在一個地方定義.5所有的預處理器命名從第一列開始寫.但是在“#if的嵌套內部的預處理器命令語句縮

12、進“一個空格.在預處理器命令之間的,用通常的C語言寫的code和按上下文件的C語言寫的code局部進行宿進.6所有的預處理器命名用小寫字母寫.7定義的宏名全都寫在同一個欄上.8被宏定義的原常數字符串和關聯的常數排頭放在同一列上.9宏名命名規定.宏名在20個字符以內.宏名都用大寫字母寫.構成宏名的各詞匯間用'_'下劃線隔開.根據3-1命名的一般指針及3-3關于詞匯省略進行構成宏名的各詞匯的選定、順序、省略.10對于所有宏,用行末注解表示宏使用目的.但是宏名充分的表達了使用目的時可省略.11宏有單位時必須注釋.12定義只在物定的函數內使用的宏,在行末注解上寫其函數名.6宏定義格式的

13、例子反例正例7-1對宏函數定義、使用的規定1關于宏函數的制作、使用,遵照以下的規定.宏制作者記述該宏的理由書關于該處理,制成宏比函數好的根據.復驗碼時,對復驗說明制作該宏的理由.由上述的復驗者判斷宏是否比函數好,成認宏的使用.對于將來有泛用使用可能的宏,全部在軟件技術部一并治理、把它保存在專用的包含文件內、作為任何人都可以利用的資產.2制作宏時要特別注意以下幾點：把宏內使用的所有的變量以括號括起來.把記述的宏全體以括號括起來.3使用宏時注意以下幾點對于任何宏,對宏的自變量只代入變量.不許代入數式、函數.7-2危險的宏函數制作、使用的例子危險的宏函數以及發生副作用的例子8.關于用戶定義型的規定1

14、關于在多個源文件間共同使用的用戶定義型,在包含文件內進行說明.2關于在一個源文件間共同使用的用戶定義型,全部在包含文件內的“型定義節內進行說明.3在“型定義節的標題設置明確表示節開始的注釋框.4只在一個函數內使用的用戶定義型可以在各個函數內部進行其說明.5說明型的順序,格式遵照變量定義的順序.6用戶定義型必須以tpyedef'進行說明,不許以宏定義進行說明.7舊型名/新型名的標題應同時以同一行對齊.8用戶的定義型,在名字的最后加t'.9在行末,對用戶定義型附加明確表示形式用目的的注釋.但型名可以明確而充分地表示時,可以省略.反例正例9.關于構造體說明的規定1多個源文件間共同使用

15、的構靠體含外部函數的自變量,在包含文件內進行說明.2在一個源文件內共同使用的構造體,全部在源文件內的“構造體說明節中進行說明.3“構造體說明節的標題要設置明確表示節開始的注釋框.4只在一個函數內使用的構造體在各個函數內部進行說明.5希望構造體個數越少越好Max15為標準.但是,關于依存CD-ROM等的數據構造的內容不適用這個標準.6關聯性強的成員另外來作為構造體說明,使構造體嵌套.7構造提嵌套的濃度的最大值為3.8上述的限制內的說明不可能時,或增加成員個數,或分割構造體,但盡量不要加深嵌套.9說明構造體的時候,在付與顯示其用途的注釋之前,對各個變量付與行末注釋.但是,對于變量名,如果其變量名可

16、以充分表達其內容的話,可以省略行末注釋.10構造體一定要根據typedef'、預先作為一個型進行說明.但是,存在自己參照批示字的時候,不使用typedef'、而以struct'進行說明,制作標簽.11以struct'進行構造本說明時,實體的定義也要和構造體的說明區別開來進行.12標簽名、構造體名的末尾要加_t'.13對于構造體的各個成員要付與表示其內容的注釋.但對于成員名可以充分表示其目的的命名,可以省略其注釋.10 .構造體說明的例子反例好例11 .變量定義的格式規定1按內存類、數據類進行變量定義.但是相互關聯性強的不同類型的變量也可以作為一個變量群進

17、行定義.2不同類型的定義之間或沒有關聯性的變量群之間加一個空行.3一行只作一個變量定義.但是象坐標x、y、z,緯度、經度等對同時進行定義有非常重要意義的在一行可進行多個變量定義.4同一個類型說明多個變量時,變量一一寫型名.5同一類型的變量把變量名的排頭放在同一列.6原那么上變量說明的的后面加行末注解.但是變量名能充分表達變量內容時也可省略.7綜合定義關聯性強的變量時,在定義前注解關聯內容.8原那么上按以下順序定義變量用戶定義型文件指針構造體共用體signedchar但是char表示signedchar時unsignedcharunsignedshortunsignedlongcharshort

18、long12 .變量定義的例子好例13 .關于變量定義的規定1變量的使用目為一個,原那么上禁止以多個目的使用變量.例如：'iProcesCounter"變量作為徨的計數器和通過的node數使用、付與隱茂意義例如：根據修改更新用參數傳遞的變量判斷處理該文件還是skip.2） 不寫內存atuo'.3） char型變量的string長宏定義其字符串的最大字符數,用宏+1說明.4注意以下類型的使用'const''enun'-原那么上禁止使用.14.關于全程變量規定原那么上禁止在多個源文件間使用全程變量.但是由于處理上的需要不能不使用時,根據以下

19、規定使用.1只把在各任務或任務組上共同使用的構造體數據作為對象.盡量不進行只在一個源文件內使用的數據或不是構造體的變量的全局化.2） 全程變量的定義在使用其全程變量的任務或任務組的最上位函數新函數定義的源文件內的“全程變量定義section上進行.3） 在“全程變量定義section的前面要有明顯section開始的注釋框.4） 在命名全程變量時附加3-4上講過的范圍限定符.5） 定義全程變量時必須附加以下注釋.變量保存的數據的內容.初始化條件.變更條件.6在定義全程變量時不能進行初始化.7loop中盡量不使用全程變量.15 .全局變量定義/使用的例子好例16 .11在一個源文件內的多個函數間

20、共通使用白變量全部在源文件內的“文件static變量定義節進行定義.2） “文件static變量定義節的前面要有明確表示節開始的注釋框.3） 定義文件static變量的時候,一定要付加以下的注釋.變量保存的數據的內容.變更開始化的條件.變量變更的條件.4定義文件static變量時,不能同時進行初始化.5進行文件static變量定義的同時需要進行定義的某個宏,為了強調那些關聯性,可以以文件static變量定義節同時進行定義.17 .對于全局函數extern說明的規定1） 從該源文件的外部進行讀取的彳瓦函數的使用說明以原型說明代用,原那么上不進行extern說明.但是,需要extern說明時,在進

21、行原型說明的包含文件內,在符合函數的原型說明之后,配合進行.2） 需要進行extern說明時的格式以下述形式進行.具體的應該注意以下幾點.自變量一行只記述一個.不同函數的說明之間參加一行空行.18 .關于原型說明的規定1對在該源文件內定義的所有函數進行原型說明.2關于只在該源文件內進行讀取的局部函數,把原型說明在源文件內的“原型說明節一并全部進行.3關于從該源文件外部進行讀取的局部函數,在包含文件內進行原型說明,在源文件內的“原型說明節包含這個包含文件.4） “原型說明節的前面設置明確表示節開始的說明框.5） 進行原型說明的函數順序與在源文件內定義的函數的順序一致.但是,在包含文件內進行原型說

22、明的全局函數不適用此標準.6在包含文件內進行原型說明的時候,其函數注釋被保存的源文件名.7原型說明的格式以下面舉的好例的形式進行.具體的注意以下幾點.自變量一行只記述一個.不同函數的說明之間參加一行空行.RlobalVarible全局變量FileStaticVariable文件static變量FunctionStaticVariable函數static變量8） 對全體函數記述注釋框時,在函數內部進行修改時,一定要記述以下的內容.RevisionHistory修改履歷9） 對全體函數記述注釋框,盡可能記述以下的內容.CalledBy讀取原來的函數10注釋英語、日語都可以.19.關于調試開關的規定

23、1一個調試開關盡量在一個開關內定義為有效.2對多個源文件有效的調試開關,在調試開關專用的包含文件內進行定義.3只對該源文件有效的調試開關全部在源文件內的調試開關定義節內進行定義.4調試開關定義節的開頭設置明確顯示節開始的注釋框.5調試開關定義的格式以宏定義的格式為基準.6調試開關的命名規定在調試開關前面設置'D'調試的意思調試開關的命名要明確顯示調試的內容.1-1函數的調用和返回值的定義1在注釋框上寫函數是否歸還返回值.2歸還返回值的函數在注釋框上寫返回值的種類、意思、是否把發生錯誤狀態作為返回值返回.3） 返回錯誤狀態時調用的上位函數必須在下位函數返回處理的后面編入錯誤檢查邏

24、輯.4表示函數執行后狀態靜態的返回值在以下范圍內使用整數.返回值用表示返回狀態的名字宏定義.在函數內使用該宏名判斷錯誤狀態.0:處理成功1 <=:處理成功表示詳細的成功狀態.任意數值-1>=:處理失敗-99:致命的錯誤狀態100以下：警告層的錯誤狀態5各任務組把在自己組內使用的函數的返回值宏和使用的功能單位匹配保存在包含文件上任務組全體,多個任務之間或一個任務內,etc.根據“處理標準決定保存在那一層的包含文件上.6上述返回值宏中為了防止任務組間的雙重定義,必須在宏接受頭附加任務組名或外部變量用的范圍限定符.1-2函數的分類和規定11函數分成以下四種無返回值函數一般返回值函數布爾函

25、數指針函數不屬于以上四種函數的沒有特別規定.但是盡量讓函數屬于以上四種.2函數的分類無返回值函數概要根據從上位函數傳遞的參數代行一系列處理的函數.返回值是表示處理結果成功、失敗的狀態.函數型推薦int型.例子翻開文件讀入數據etc命名fypeFunctionNametype:表示返回值型的接頭詞.根據3-4寫FunctionName:函數的標識符調用格式ReturnCode=typeFunctionNamw-,-,-返回值根據6-1的4準備返回值的宏定義.備考調用這類函數的函數一定是無返回值函數,檢查一正是否發生了錯誤.一般返回值函數概要根據上位函數傳遞的參數,進行數據加工的函數.返回值是加工

26、后的數據.例子算術計算etc命名fypeFunctionNametype:表示返回值型的接頭詞.FunctionName:函數的標識符調用格式ReturnCode=typeFunctionNamw-,-,-返回值任意型根據6-1的4準備返回值的宏定義.正常處理的返回值能取正負值時返回值任意.1-3函數的分類和規定21)布爾型函數概要根據上位函數傳遞摻數判些例題的真偽.返回值是判斷命題真偽的結果.例子判斷自車是否在行使中.Etc型Boolean-t:布爾型IsFunctionNameIS:表7K布爾型的接頭詞FunctionName:函數的標識符命題的實質(調用格式)IsFunctionName

27、(-,-,-)返回值IRUE:0以外推薦1FALSE:0備考這個函數主要用于判斷限制語句的條件.2)指針型函數概要處埋要要和尢返回值函數一樣.不同的是返回值是保存在批針的地址.例子內存的分配etc(命名)FunctionNamep:表示批針type:表示返回值型的接頭詞FunctionName:函數的標識符調用格式ReturnCode=typeFunctionNamw-,-,-,status;返回值ReturnCode:任意的指針型變量NULL:處理成功NULL:處理失敗Status：想在上述ReturnCode上再附加信息時使用.一般情況下可以不使用.ReturnCode是NULL以外的情況

28、0:正常1«=:正常的詳細狀態ReturnCode是NULL以外的情況- 1?=：異常的詳細狀態- 1-99:致命的錯誤- 100以下：警告錯誤備考調用這類函數的函數一定是指針型函數,檢查是否發生了錯誤.2對于函數參數的規那么1函數定義時,每一行只寫一個參數.2參數的順序為,i輸入、參照,io修正、更新,o輸出3一個函數的參數個數最好不超過4個,但有發票時可設到7個.4只把在函數內使用的變量叫作函數的參數.不使用的變量原那么上不作為參數.但是結構體定義的一些變量在處理上使用時包括不的結構體成員整個結構體成為函數的參數.而且為站起來的開發擴大、向當前可定義空的參數.5結構體定義的一些變

29、量使用于處理時,在變量個數不超過將其結構體的的所有成員作為函數的參數,超過7時可一個結構體,把這個結構體的指針作為參數.3 函數的commentbox1） 寫函數全體的commentbox時,必須寫以下工程.FunctionName函數名Description處理記述ReturnCodE返回值ReturnCodeJudgement有無判斷錯的必要性Data制作日期Author制作者,公司名2） 寫函數全體的commentbox時,如果使用了如下工程,那么必需記述.GlobalVariable全程變量FileStaticVariable文件Static變量FunctionStaticVariab

30、le函數內Static變量3） 寫函數全體的commentbox時,對于以下工程如果在函數內部作了修改,那么必需記述.RevisionHistory修改履歷4） 寫函數全體的commentbox時,盡量寫出以下工程.CalledBy調用函數5） 注釋可用日文或英文.4 對于函數內部LAYOUT的規那么1函數的大小定為60行以內除去注釋,空行,變量定義,調試開關.但由于switch語句而出現多個分支處理時,這局部不包含在大小上.2函數內部的一行語句的最大字符數為120字符.3函數定義與commentbox之間不加空行.4函數定義從第一列開始寫.5函數的參數一行寫一個.6函數定義時在所有參數后面付

31、加行末注釋,但從命名可充分理解其內容時,可省略注釋.7函數開始的“與函數定義行之間不加空行.8表示函數開始和結束的“和“從第一列記述.9函數的第一行從第一列開始縮進1個TAB相當于4個半角空格.10函數的執行語句結束以后與“之間不加空行.5對于函數內部中的注釋的一般規那么1） 在函數內部,對于每個適合處理的BLOCK,為了輔助理解CODE而設注釋.2） 在函數內部使用的注釋有如下兩種形式.行注釋一一在要處理的BLOCK的上一行設注釋用行的注釋.行末注釋一一對于在一行上記述的內容只在該行行末上記述的注釋.3） 對于函數內部處理的注釋原那么上使用行注釋,但對于只寫一行的處理可用行末注釋確切的說明時

32、,可使用行末注釋.4對于函數內部的處理使用行注釋時注釋與前面的執行語句之間空一行.但是行注釋前后的執行語句關聯性強時可不加空行.5對于函數內部的處理使用行注釋時,注釋與對象CODE對齊縮進.CODE的開頭與表示注釋開始的“/放在同一列上.6用一行的行注釋不能記述內部處理時,用多個行寫.這時/*和*/要和前行寫在同一位上.7在函數內部變量定義時對所有變量附加行末注釋.但是變量名能充分說明其內容的可省略.8放在code修改地方的“明示修改場所的注釋盡量使用行末注釋.但是行末沒有充實的空格時可記述在該code的下一行行末或code的前一行.多個行都有修改時為了明確修改code的范圍在修改開始位置和完

33、了位置上附加注釋.9“明示修改場所的注釋只寫以下工程.該函數內進行修改的號修改日期修改者名只在多個行都有修改時標明開始位置和完了位置標記具體是/*No196/04/15/Isuzuki-start*/*No196/04/15/Isuzuki-end*/10修改的具體內容和上述8一起寫在修改函數的注釋框內具體例子參照6-3函數注釋框11對于源文件全體的注釋框上寫修改日期、修改者名、被修改的函數名.具體例子參照4-3源文件注釋框補助用英語寫注釋時為了明了注釋與code的區別增加表示注釋開始完了的*來提升易讀性.6函數內部中的變量定義和初始化1只用于函數內部的局部變量的定義,都在函數的開頭進行,但對

34、于只用于調試的變量,可在調試局部定義.2） 對于在函數內部進行定義,且只用于函數內部的變量,可在定義的同時初始化.但為了限定變量使用的范圍,推薦在具體使用之間初始化.3） 對于在函數外部定義的filestatic變量、全局變量,有初始化的必要時,在其變量使用前具體初始化.4） 在同一個函數內定義的局部變量的個數為7個以內,但不要為了減少個數把同一個變量用于不同的目的上.7對在函數內部的多行命題記述的規定1一行中不記述多個命題.但除了for語句的限制條件語句.2把一個例題分割為多行時,第2行以后縮排2個tob半角空格4乘2.第3行以后與第2行對齊.但使用'='時的縮排標準參照下面的5.3把一個命題分割為多行時,中途行的結尾一將繼續向下一行繼續的形式,或算術演算符倫理演算符結束,盡量不要以變量記述來終了.4在演算中途分割行時,以結合弱的演算符+分割.5把含有'=的算術演算分割為多行時,右邊的變量、演算符盡量全部在右邊