所谓无规矩不成方圆。任何团队规范都是怎么也绕不开的话题。特别是在我们搞嵌入式C开发的代码规范乃是开发的重中之重。有太多的理由去做规范因为每个人的代码编写喜好不同代码风格也迥然不同。每一个程序员心目中对好代码都有自己的主见统一的编码规范可以像秦始皇统一战国一样避免不必要的论战和争议。有时候会帮同学看一下代码发现大多写代码都是随心所欲。看起开非常头大虽然C语言很重要但是C语言代码规范也非常重要。今天分享的就是安富莱C语言编码规范建议初学者去官网看看他们的代码非常标准 一、文件与目录1、文件及目录的命名规定可用的字符集是A-Za-z0-9._-。2、源文件名后缀用小写字母.c和.h。3、文件的命名要准确清晰地表达其内容同时文件名应该精练防止文件名过长而造成使用不便。在文件名中可以适当地使用缩写。以下提供两种命名方式以供参考1各程序模块的文件命名开头 2 个小写字母代表本模块的功能如主控程序为mpMain.cmpDisp.c …2不写模块功能标识如主控程序为Main.cDisp.c …4、一个软件包或一个逻辑组件的所有头文件和源文件建议放在一个单独的目录下这样有利于查找并使用相关的文件有利于简化一些编译工具的设置。5、对于整个项目需要的公共头文件应存放在一个单独的目录下(例如myProject/include)下可避免其他编写人引用时目录太过分散的问题。6、对于源码文件中的段落安排我们建议按如下的顺序排列7、在引用头文件时不要使用绝对路径。如果使用绝对路径当需要移动目录时必须修改所有相关代码繁琐且不安全使用相对路径当需要移动目录时只需修改编译器的某个选项即可。#include “/project/inc/hello.h” /* 不应使用绝对路径 */#include “../inc/hello.h” /* 可以使用相对路径 */8、在引用头文件时使用 来引用预定义或者特定目录的头文件使用 “” 来引用当前目录或者路径相对于当前目录的头文件。#include /* 标准头文件 */#include /* 工程指定目录头文件 */#include “global.h” /* 当前目录头文件 */#include “inc/config.h” /* 路径相对于当前目录的头文件 */9、为了防止头文件被重复引用应当用ifndef/define/endif结构产生预处理块。#ifndef __DISP_H /* 文件名前名加两个下划线“__”后面加 “_H”#define __DISP_H......#endif10、头文件中只存放“声明”而不存放“定义”通过这种方式可以避免重复定义。/* 模块 1 头文件module1.h */externint a 5; /* 在模块 1 的 .h 文件中声明变量 *//* 模块 1 实现文件module1.c */uint8_t g_ucPara; /* 在模块 1 的 .h 文件中定义全局变量 g_ucPara */11、如果其它模块需要引用全局变量g_ucPara, 只需要在文件开头包含module1.h/* 模块 2 实现文件module2.c */#include “module1.h” /* 在模块 2 中包含模块 1 的 .h 文件 */......g_ucPara 0;......12、对于文件的长度没有非常严格的要求但应尽量避免文件过长。一般来说文件长度应尽量保持在1000行之内。二、排版1、程序块要采用缩进风格编写缩进的空格数为 4 个。2、相对独立的程序块之间、变量说明之后必须加空行。voidDemoFunc(void){uint8_t i;/* 功能块 1 */for (i 0; i 10; i){...}/* 功能块 2 */for (i 0; i 20; i){...}}3、作符处划分新行操作符放在新行之首划分出的新行要进行适当的缩进使排版整齐语句可读。if ((ucParam1 0) (ucParam2 0) (ucParam3 0)|| (ucParam4 0)){......}4、不允许把多个短语句写在一行中即一行只写一条语句。rect.length 0; rect.width 0;rect.length 0;rect.width 0;5、对齐使用TAB 键1 个 TAB 对应 4 个字符位。6、函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格case 语句下的情况处理语句也要遵从语句缩进要求。7、程序块的分界符如大括号‘{’和‘}’ 应各独占一行并且位于同一列同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及 if、for、do、while、switch、case 语句中的程序都要采用如上的缩进方式。对于与规则不一致的现存代码应优先保证同一模块中的风格一致性。for (...) {... /* program code */}for (...){... /* program code */}if (...){... /* program code */}if (...){... /* program code */}8、在两个以上的关键字、变量、常量进行对等操作时它们之间的操作符之前、之后或者前后要加空格进行非对等操作时如果是关系密切的立即操作符(如)后不应加空格。说明采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的所以在已经非常清晰的语句中没有必要再留空格如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格多重括号间不必加空格因为在 C语言中括号已经是最清晰的标志了。在长语句中如果需要加的空格非常多那么应该保持整体清晰而在局部不加空格。给操作符留空格时不要连续留两个以上空格。1逗号、分号只在后面加空格。int_32 a, b, c;2比较操作符赋值操作符、 算术操作符、%逻辑操作符、位域操作符
)
