[2017年整理]C语言的编码标准

《[2017年整理]C语言的编码标准》由会员分享，可在线阅读，更多相关《[2017年整理]C语言的编码标准（14页珍藏版）》请在金锄头文库上搜索。

1、C 语言编码标准 关于命名标准1 对命名的一般方针1) 进行命名的时候在充分把握对象数据（变量、函数、etc）的内容的基础上，再进行能明确显示其内容的名命名。2) 要实行不需要注释的命名3) 命名满足不了上述 1、2 条件的时候，是否是以多意使用其变量、很可能是函数分割的不充分。进行上述的修改之后，试试再次进行命名。4) 不限制单词数5) 各单词的开头用大写字母，并以此作为文字区分符。6) 单词昼选择容易明白的（单纯的）英语单词。7) 不要省略必要的前置词。8) 禁止只以大写字母/不写字母的不同来区别命名。9) C 语言习惯使用的单词可以就那样使用。10) 命名时不要使用 C 语言的保留字。1

2、1) 禁止在数据的一部分插入数字区别数据2 遵照对命名的方针的命名例子采用经常被使用的表现形式，举一个根据英语命名的具体例子1) 动词+目标字或目标字+ 动词（的过去分词）2) 前置词from的使用方法3) 的4) 在内，做3 关于单词的省略1)规定 1 积极使用省略词词典编目过的省略词。规定 2 制作省略词词典中未编目歧视的省略词，要遵照以下规定： 省略以前单词不满 6 个字的不省略。 （RoadRd ） 不进行只有一个字的省略。 （BMWBW） 省略词最短的长度为 3 个字。但经常被使用的省略词（TV、CD、etc）除外。规定 3 制作省略词词典未编目的省略词时，遵照以下的顺序。 有一般的

3、省略词时，使用一般的省略词。 取消不必要的后缀 以最初的第 1、第 2 音节作为省略词（但是，如果能够料想到相同省略词经常发生的时候，不要采用这种方法） 。 消除在单词开头的元音以外的元音。 以上方法不一定同时采用，总之，要选择合适的方法制作易懂的省略词。规定 4 对于以多个单词表示一个意思的词汇，可以以各个单词的打头字作为省略词。这时候，打头字要全部为大写（ex Unit Bulletin BoardUBB）规定 5 对于以多个单词表示一个意思的词汇，可以以各个单词的打头字和其他的单词或其他单词的省略词作为省略词。这时，省略词的打头字以及文字区分符都要大写。 （ex Vics DataVda

4、ta）规定 6 把新制作的所有的省略词编录到省略词词典上。2) 按照省略词制作的规定制作的省略词的例子，参照另外的省略词词典。4 对变量/函数的命名规定1) 变更名要在 20 个字以内，函数名要在 30 个字以内。2) 变量/函数名的构成要素为（范围限定符） +（型）+（标识符）3) 对在多个源文件之间共同使用的全程变量/函数付与范围限定符、对只在单一源文件内使用的局部变量/函数付与不付与都可以。4) 范围限定符是 23 个字符的小写字母。使用登记在各组的范围限定符。5) 型使用以下字母。6) 型是小写字母。7) 指针、数组的接头词各自使用p a8) 含指针、类型的变量/函数名的命名方法遵照以

5、下规单。 对排列的指示字（pointer to array）（范围限定符_）+pa+（型）+（标识符） 标识符的排列（array of pointer）（范围限定符_）+ap+（型）+（标识符）9) 关于用户定义型原则上不定义型名（比如说，独自制作了为 OriginaData 名的 int 型的用户定义型时，对变量名附加了表示原来型名的 I 成为I-* ） 。但是关于在软件技术部全体共同使用的用户定义的型，应该一并管理，制作共同使用的型名的接头词。10) 标识符最低含一个名词。 关于源文件整体的标准1 源文件的构成1) 源文件的全体构成为以下内容（只是根据源文件，有时不存在相应的段） 。 源文

6、件的注释框 包含文件部分 宏定义部分 型定义部分 构造体定义部分 综合变量定义部分 文件 static 变量定义部分 原型说明定义 调试开关定义部分 函数定义部分2) 一个源文件的最大行数为 800 行。3) 源文件中行中的语句的最大文字数为 120。4) 文件内一个标记为 4 个半角空格。 （另外，以汇编程序编程时，一个标记也要尽量为 4个半角空格，必须为 8 个半角空格时，也要以 4 个半角空格为 1 个标记，分为 2 个标记） 。2 源文件内函数的配置1) 在一个源文件内，从相同文件内的哪个函数都调不出的最上层的函数（全局函数）只定义一个。但是，小的全局函数并列构成的任务（例：mode

7、的 key 处理等）或在 4 章中。2) 叙述的共同函数文件不适用这个标准。3) 一个源文件内函数定义的顺序以最上层的函数为打头，按以后进行处理的顺序定义。4) 在一个函数内，从多个函数调出的共同函数，在相同源文件的末尾整理定义。5) 在多个源文件的调出的共同函数，按照功能整理，制作只定义共同函数的共同函数文件函数。但是，共同函数有很多，一个源文件归纳不了时，按照功能分为几个源文件。3 对源文件的注释框源文件注释框按照以下的例子，记叙所有的项目。适当的记叙项目没有时，记述为“无” 。注释英语、日语都可以。 对各种说明、定义的标准1 制作包含文件的规定1) 包含文件名全部用小写字母命名。2) 包

8、含文件由以下项目构成，除以下项目外不写其它项目。但没必要写以下全部项目。 包含文件用注解框（必须写） 宏定义（没有时可省略） 型说明（没有时可省略） _ _& 构造体说明（没有时可省略） 函数保留说明（没有时可省略） extern 说明（没有时可省略）3) 在注解框上写在读取该包含文件前需要读取的包含文件。4) 包含文件内的定义、说明可在多个源文件内使用。5) 包含文件内各种数据的定义、说明格式按源文件的标准。6) 包含文件内希望不包含其他文件。2 在包含文件内进行定义的 mask 常数/ 状态常数的规定1) 进行 flag 等 bitdata 的 mask 的常数（以后叫 mask 常数）和

9、表示 bit 状态的常数（以后叫状态常数）必须在包含文件内进行宏定义。2) mask 常数和状态常数对于用户定义的 bit 必须按组定义。而且，不管使不使用也一起定义相反的 mask 常数和状态常数。但是对于从 CDROM 读入的数据中的 bit，只定义 mask 常数即可。3) 只有一个 mask 常数用直接值定义。和它有关联的各种常数用逻辑式进行定义（如用于检测它的状态和相反状态的 mask 常数、根据该 mask 常数应测出的状态常数等） 。4) 和 mask 常数、状态常数一起定义 mask 运算对象的变量（以后叫静态变量）和 bit 宽。5) mask 常数的命名规则 在名字的最后加

10、“_MASK” 取静太变量和逻辑语时测出上述状态以外所有状态的 mask 常数，在上述 mask 常数前加“NOT ”（NOT_状态_MASK） 不能在 mask 常数名中加表示 bit 位置的数据（_2bit_MASK） 。 为测出一个状态定义一个 mask 常数。不能把用一个 mask 常数测出多个状态作为目的。 对 mask 常数不能进行明确表示应测出的状态的命名时，有可能为测出多个状态而进行 mask 常数定义。这时按各自目的分开讨论。6) 状态常数的命名规则 定义根据和上边命名的一个 mask 常数的逻辑运算应测出的表示一个状态的状态常数不能把多个状态用一个状态常数表示。 对于一个状

11、态常数定义一个表示取反状态的状态常数时，为了明确表示它们是互相取反状态，在状态常数名前加“NOT” 。3 包含文件内的屏蔽定数/状态定数定义的例子（反例）在源文件中记录下的编码（正例）在 unde 中记录以下的编码4 关于源文件中包含文件节的格式的规定1) 在一个源文件中使用的包含文件全部以“包含文件节”包含。但是，函数的 extern 说明被保存的包含文件要以全局函数的 extern 说明节包含。2) 在“包含文件节”的标题要设有表示节开始的注释框。3) 把包含文件节分割为以下的种类： C 语言标准的头文件 E1 系统共同的头文件 任务组共同的头文件 模型共同的头文件 任务共同的头文件4)

12、定义归纳为各个种类进行，并在各个种类的段落上附加说明以及空格行。5) 各个各类定义的顺序按以上的顺序。6) 对 E1 系统共同的头文件以下付与显示其使用目的的注释。7) “#include”全部用小写字母记述。8) 展开的个组文件的标题要对刘到同一列上。5 宏定义和预处理器命名格式的规定1) 在多个源文件上使用的宏全部包含文件内定义。根据处理标准 决定保存在哪一层。2) 在一个源文件内使用或在一个函数内使用的宏癸源文件内的“宏定义 section”上定义。3) 在“宏定义 section”的开头设一个明确 setion 开始的注解框。4) 关联性强的宏归纳在一个地方定义。5) 所有的预处理器命

13、名从第一列开始写。但是在“#if”的嵌套内部的预处理器命令语句缩进“一个空格” 。在预处理器命令之间的，用通常的 C 语言写的 code 和按上下文件的 C 语言写的 code 部分进行宿进。6) 所有的预处理器命名用小写字母写。7) 定义的宏名全都写在同一个栏上。8) 被宏定义的原常数（字符串）和关联的常数排头放在同一列上。9) 宏名命名规定。 宏名在 20 个字符以内。 宏名都用大写字母写。 构成宏名的各词汇间用_ （下划线）隔开。 根据 3-1 命名的一般指针及 3-3 关于词汇省略进行构成宏名的各词汇的选定、顺序、省略。10) 对于所有宏，用行末注解表示宏使用目的。但是宏名充分的表达了

14、使用目的时可省略。11) 宏有单位时必须注释。12) 定义只在物定的函数内使用的宏，在行末注解上写其函数名。6 宏定义格式的例子（反例）（正例）7-1 对宏函数定义、使用的规定1) 关于宏函数的制作、使用，遵照以下的规定。 宏制作者记述该宏的理由书（关于该处理，制成宏比函数好的根据） 。 复验码时，对复验说明制作该宏的理由。 由上述的复验者判断宏是否比函数好，承认宏的使用。 对于将来有泛用使用可能的宏，全部在软件技术部一并管理、把它保存在专用的包含文件内、作为任何人都可以利用的资产。2) 制作宏时要特别注意以下几点： 把宏内使用的所有的变量以括号括起来。 把记述的宏全体以括号括起来。3) 使用

15、宏时注意以下几点 对于任何宏，对宏的自变量只代入变量。不许代入数式、函数。7-2 危险的宏函数制作、使用的例子（危险的宏函数以及发生副作用的例子）8. 关于用户定义型的规定1) 关于在多个源文件间共同使用的用户定义型，在包含文件内进行说明。2) 关于在一个源文件间共同使用的用户定义型，全部在包含文件内的“型定义节”内进行说明。3) 在“型定义节”的标题设置明确表示节开始的注释框。4) 只在一个函数内使用的用户定义型可以在各个函数内部进行其说明。5) 说明型的顺序，格式遵照变量定义的顺序。6) 用户定义型必须以tpyedef进行说明，不许以宏定义进行说明。7) 旧型名/新型名的标题应同时以同一行

16、对齐。8) 用户的定义型，在名字 的最后加t 。9) 在行末，对用户定义型附加明确表示形式用目的的注释。但型名可以明确而充分地表示时，可以省略。（反例）（正例）9. 关于构造体说明的规定1) 多个源文件间共同使用的构靠体（含外部函数的自变量） ，在包含文件内进行说明。2) 在一个源文件内共同使用的构造体，全部在源文件内的“构造体说明节”中进行说明。3) “构造体说明节”的标题要设置明确表示节开始的注释框。4) 只在一个函数内使用的构造体在各个函数内部进行说明。5) 希望构造体个数越少越好（Max15 为标准） 。但是，关于依存 CD-ROM 等的数据构造的内容不适用这个标准。6) 关联性强的成员另外来作为构造体说明，使构造体嵌套。7) 构造提嵌套的浓度的最大值为 3。8) 上述的限制内的说明不可能时，或增加成员个