C语言简明规范副本.doc

C语言简明规范 1·关于命名标准 1-1对命名的一般方针 1）进行命名的时候，在充分把握数据对象（变量、函数、etc）内容的基础上，进行能明确显示其内容的命名。 命名满足不了上述1、2条件的时候，观察是否是以多意使用此变量，这可能是函数分割的不充分。进行相关的修改之后，试试再次进行命名。 不限制命名的单词数 各单词的开头用大写字母，并以此作为文字区分符（不使用下划线） 单词尽量选择容易明白的英语单词。 不能省略必要的前置词 禁止只以大写字母/小写字母的不同来区别命名 C语言习惯使用的单词可以保留使用（argc argv） 命名时不要使用C语言的保留字(FOR) 禁止在数据的一部分插入数字区别数据 1-2遵照对命名的方针的命名例子 采用经常被使用的表现形式，举一个根据英语命名的具体例子 动词+目标字 或 目标字+动词（的过去分词 ） 变量/函数名 含义 GetData 取得数据 PassData 递交数据 DeleteDataFromCD 从CD删除数据 PassFuntionParameter 向函数递交自变量（PassParamrterToFunction也可以） 1-3对变量/函数的命名规定 变量名要在20个字符以内，函数名要在30个字符以内。 变量/函数名的构成要素为[（范围限定符_）+（型）+（标识符）] 对在多个源文件之间共同使用的全局变量/全局函数需要添加范围限定符；对只在单一源文件内使用的局部变量/函数加与不加与都可以。 作为对指针、数组的接头词，使用各自的‘p’、‘a’。 含指针、数组的变量/函数名的命名方法遵照以下规章。 (对数组的指针（pointer to array） （范围限定符＿）+ pa +（型）+（标识符） ( 对指针数组（array of pointer） （范围限定符＿）+ ap +（型）+（标识符） 关于用户定义型原则上不记录型名（比如说，独自制作了为0riginaData名的int型的用户定义型时，对变量名附加了表示原来型名的i成为‘i-***’，而不把省略了0riginaData的ot作为型名称为‘ot-***’）。但是关于在软件技术部全体共同使用的用户定义的型，应该一并管理，制作共同使用的型名的接头词。 标识符最低含一个名词。 2．关于源文件整体的标准 2-1源文件的构成 一个源文件的最大行数为800行（包含注释和空行）。 源文件中1行中的语句的最大文字数为120。 文件内一个TAB为4个半角空格。（另外，以汇编程序编程时，一个TAB也要尽量为4个半角空格，必须为8个半角空格时，也要以4个半角空格为1个TAB，分为2个TAB） 2-2源文件内函数的配置 在同一个源文件内，哪个函数都不调用的最上层的函数（全局函数）只定义一个。但是，小的全局函数并列构成的任务（例：mode的key处理等）例外。 一个源文件内函数定义的顺序以最上层的函数为打头，以后按进行处理的顺序定义。 在一个函数内，被多个函数调用的共通函数，在源文件的末尾整理定义。 被多个源文件的调用的公共函数，按照功能整理，制作只定义公共函数的公共函数文件。但是，公共函数有很多，一个源文件归纳不了时，按照功能分为几个源文件。 2-3对源文件的注释框 源文件注释框按照以下的例子，记叙所有的项目。当记叙项目没有时，记述为“无”。注释使用英语、汉语都可以。 /********************************************/ 3对各种说明、定义的标准 3-1关于制作包含文件的规定 包含文件名全部以小写字母书写。 关于在读入有关文件时，有必要先读进的头文件（Required IncIude File），在注释框中记述。 包含文件内的各种数据的定义/说明的格式，以在源文件内的内容为标准。 3-2关于宏定义和预处理器命令格式的规定 跨越多个文件使用的宏全部在包含文件内定义。 只在一个源文件内，或只在一个函数内使用的宏，全部以包含文件内的“宏定义节”进行定义。 “宏定义节”的标题，要设有表示开始的注释框。 关联型强的宏之间要在一个地方归纳整理，统一定义。 所有的预处理器命令（#define、#if、#include、#etc）从第一列开始叙述。但是在根据“#if”等的嵌套内部，要缩进“一个空格”。但 是被预处理器命令包围的、以通常的C语言记述的代码要和前后以C语言记述的代码对齐缩进。 所有的预处理器命令以小写字母记述。 定义的宏名字全部记述在同一列。 关于宏定义的原常量及有关联内容的常量，应对齐在同一列上。 宏名字命名的规定 宏命令的名字要在20字以内。 宏命令的名字全部以大写字母记述。 构成宏名字的各单词之间要以‘-’区分。 关于构成各单词的选定、顺序、省略方法等，遵照3-1对命名的一般方针、以及3-3关