C语言代码编程规范

C语言代码编程规范C语言编程规范约定整理于2021-9-13，来源于uc/os-ii，奉行天下编程规范约定应建立于一项工程之初，且该约定应贯穿整个工程之始终。采用一些规约有助于提高劳动生产率，并使工程软件便于维护。用C语言或其他语言编写程序的方式有很多种，惯用的，好的书写风格以及他人用的一些好的方法，无非是想力图达到以下的目的：●可移植性好；●兼容性好；●干净整齐；●易维护性好；●易看懂；●简明扼要；无论采用哪种编程风格，必须在整个工程中采用始终如一的格式。1.0文件头1.1公司的名称和地址写在前几行；然后是标题，标出文件的主题内容；接着是著作权声明；以标明软件的专有权。1.2然后是文件名和程序员的姓名。第一个人是建立这个文件的人。1.3文件头中最后一项是对文件内容的描述。2.0文件包含2.1应用工程需要的头文件紧随在版本变更记录的后面。可以只列出本模块需要的头文件，也可以用一个名为INCLUDE.H的头文件将所有的头文件包含进去。使用INCLUDE.H文件，就不必记清楚那个头文件是给那个源文件用的，特别是增加新的模板时。这样做也存在缺点，就是编译每个模块时所需的时间要长一点。3.0标志符命名法3.1标准的C，允许32个字符命名标志符。标志符的名字应该反映该标志符的用途。推荐使用划分级别的方法命名标志符。例如OSSemPend（）:它是操作系统的一部分（OS），他是一个信号量（Semaphore）,它的功能是等待（Pend）信号量。这种方法能够将所有关于信号量的信息归纳为一组。3.2变量名的申明应该是每行一个变量，而不要再一行申明多个变量，这个易于给每个变量加注释。3.3用文件名作为变量名的前缀，不论是局部变量还是全局变量。这样，该变量是全局变量还是局部变量用在哪个文件中就很清楚。3.4可以任意给全局变量起名字，只需大写和小写字母混用，并冠以模块或文件名的前缀。3.5函数的形式参数和函数内部的局部变量用小写字母申明。为了使变量名便于阅读，可以使用下划线（_）分开各词。3.6在函数内部，可以使用一些总是具有同样含义的变量名来命名局部变量。也可以称做临时变量。比如：I,j,k循环计数；p1,p2,p3用作指针；c1,c2,c3用作字符；s1,s2,s3用作字符串；ix,iy,iz用作中间整数变量。4.0缩略，略语及助记符4.1在给变量和函数等标志符命名时，可以使用缩略写，略写及助记符。使用缩写，略语及助记符可以用较少的字符描述标志符；但是一定要保持一致性。因为一般需要建立参照表。即助记符略写参照表。5.0注解5.1如果程序和注解混在一起，就很难阅读；因此，不混合编写代码和注解，注解写在C代码的右边。当需要将注解写的很长的时候，以函数描述注解块的形式来写。6.0定义语句6.1头文件和C的源文件常需要定义一些常数和宏定义。常数和宏定义永远要大写，相应的词用下划线分开。7.0数据类型7.1C语言允许用typedef关键字定义新的数据类型。这样实现的代码可移植性很高。道不同的环境下，只需要写该定义类型处即可，而代码则不需要重新书写。8.0局部变量8.1一些源程序模块须用到局部变量，这些变量仅用于这个源文件。应将这些局部变量隐藏起来，使其他文件看不到。在C语言中隐藏这些变量是用STATIC关键字实现的。变量可以按字母顺序排列，也可以按功能排列。9.0函数原型9.1函数原型申明的书序应该是函数定义的顺序。这一顺序可以使用户能从文件中很快对应起来。注意，关键字static，返回值类型及函数名都应上下对齐。10.0函数申明10.1只用于本文件的函数应该使用static申明为静态函数，以便隐藏起来不至于与其他文件中的函数混淆。10.2作为一条规则，再写到一个函数的调用时，在函数名与参数表之间不加空格；而在定义这个函数时，在函数名与形式参数表之间加一个空格。10.3函数名应该用相应文件名作为前缀。对于中到大型的程序，这样的前缀便于知道这个函数实在哪个文件中定义的。11.0缩进格式11.1缩进格式是表达函数流程的重要手段。问题是应该缩进几个空格？一个空格显然不够，而8个空格又太多了，折中一下，4个。建议不使用制表符Tab，应该不方便打印。11.2关键字if,for,while及do后面须加一个空格。如果使用括号，则关键字else的前面和后面都需要加一个空格。12.0语句和表达式12.1语句和表达式应该在一行中完成，每行不多于一个赋值语句。12.2以下运算符的前后都不要加空格:p-mp.ma[i]12.3函数和函数后面的括号之间不要加空格；逗号后面要加一个空格，用于将函数参数表中的变元分开；括号中的表达式前后不要加空格前括号后面以及后括号的前面也不要加空格；逗号和分号的后面应该加一个空格。12.4关于赋值语句，数值要按列对齐。在添加语句时也要这样，等号也要上下对齐。13.0结构和联合13.1结构是使用typedef定义的，可以用一个标志符名代表整个结构。结构类型的申明一律用大写字母，用下划线将不同的词分开。结构成员也可以用结构的类型名开头。