嵌入式C编码需要遵循的规范有哪些？
1 最重要的规则
编写代码时最重要的一条规则是：检查周围的代码并尝试模仿它。
作为维护人员，如果收到的补丁明显与周围代码的编码风格不同，这是令人沮丧的。这是不尊重人的，就像某人穿着泥泞的鞋子走进一间一尘不染的房子。
因此，无论本文推荐的是什么，如果已经编写了代码并且您正在对其进行修补，请保持其当前的样式一致，即使它不是您最喜欢的样式。
2 一般性的规则
这里列出了最明显和最重要的一般规则。在你继续阅读其他章节之前，请仔细检查它们。
使用c99标准
不使用制表符，而是使用空格
每个缩进级别使用4个空格
在关键字和左括号之间使用一个空格
在函数名和左括号之间不要使用空格
int32_t a = sum(4, 3); /* ok */ int32_t a = sum (4, 3); /* wrong */
不要在变量/函数/宏/类型中使用_或前缀。这是为c语言本身保留的
对于严格的模块私有函数，使用prv_ name前缀
对于包含下划线_ char的变量/函数/宏/类型，只能使用小写字母
左花括号总是与关键字(for, while, do, switch, if，…)在同一行
size_t i; for (i = 0; i < 5; ++i) { /* ok */ } for (i = 0; i < 5; ++i){ /* wrong */ } for (i = 0; i < 5; ++i) /* wrong */ { }
在比较操作符和赋值操作符之前和之后使用单个空格
int32_t a; a = 3 + 4; /* ok */ for (a = 0; a < 5; ++a) /* ok */ a=3+4; /* wrong */ a = 3+4; /* wrong */ for (a=0;a<5;++a) /* wrong */
每个逗号后用单空格
func_name(5, 4); /* ok */ func_name(4,3); /* wrong */
不要初始化静态和全局变量为0(或null)，让编译器为您做
static int32_t a; /* ok */ static int32_t b = 4; /* ok */ static int32_t a = 0; /* wrong */ void my_func(void) { static int32_t* ptr;/* ok */ static char abc = 0;/* wrong */ }
在同一行中声明所有相同类型的局部变量
void my_func(void) { char a; /* ok */ char b; /* wrong, variable with char type already exists */ char a, b; /* ok */ }
按顺序声明局部变量
i. 自定义结构和枚举
ii. 整数类型，更宽的无符号类型优先
iii. 单/双浮点
int my_func(void) { /* 1 */ my_struct_t my; /* first custom structures */ my_struct_ptr_t* p; /* pointers too */ /* 2 */ uint32_t a; int32_t b; uint16_t c; int16_t g; char h; /* ... */ /* 3 */ double d; float f; }
总是在块的开头声明局部变量，在第一个可执行语句之前
在for循环中声明计数器变量
/* ok */ for (size_t i = 0; i < 10; ++i) /* ok, if you need counter variable later */ size_t i; for (i = 0; i < 10; ++i) { if (...) { break; } } if (i * 10) { } /* wrong */ size_t i; for (i = 0; i < 10; ++i) ...
避免在声明中使用函数调用来赋值变量，除了单个变量
void a(void) { /* avoid function calls when declaring variable */ int32_t a, b = sum(1, 2); /* use this */ int32_t a, b; b = sum(1, 2); /* this is ok */ uint8_t a = 3, b = 4; }
除了char、float或double之外，始终使用stdint.h标准库中声明的类型。例如，8位的uint8_t等
不要使用stdbool.h库。分别使用1或0表示真或假
/* ok */ uint8_t status; status = 0; /* wrong */ #include bool status = true;
永远不要与真实相比较。例如，使用if(check_func()){…}替换if (check_func() * 1)
总是将指针与空值进行比较
void* ptr; /* ... */ /* ok, compare against null */ if (ptr * null || ptr != null) { } /* wrong */ if (ptr || !ptr) { }
总是使用前增量(和递减)，而不是后增量(和递减)
int32_t a = 0; ... a++; /* wrong */ ++a; /* ok */ for (size_t j = 0; j 0) /* ok, length is treated as counter variable containing multi values, not only 0 or 1 */ if (length * 0) /* ok, length is treated as counter variable containing multi values, not only 0 or 1 */ if (is_ok) /* ok, variable is treated as boolean */ if (!is_ok) /* ok, -||- */ if (is_ok * 1) /* wrong, never compare boolean variable against 1! */ if (is_ok * 0) /* wrong, use ! for negative check */
对于注释，总是使用/* comment */，即使是单行注释
在头文件中总是包含带有extern关键字的c++检查
每个函数都必须包含doxygen-enabled注释，即使函数是静态的
使用英文名称/文本的函数，变量，注释
变量使用小写字母
如果变量包含多个名称，请使用下划线。force_redraw。不要使用forceredraw
对于c标准库的包含文件，请始终使用。例如，# include
对于自定义库，请始终使用。例如，# include“my_library.h”
当转换为指针类型时，总是将星号与类型对齐，例如。uint8_t* t = (uint8_t*)var_width_diff_type
始终尊重项目或库中已经使用的代码风格
3 注释相关的规则
不允许以//开头的注释。总是使用② comment */，即使是单行注释
对于多行注释，每行使用空格+星号
/* * this is multi-line comments, * written in 2 lines (ok) */ /** * wrong, use double-asterisk only for doxygen documentation */ /* * single line comment without space before asterisk (wrong) */ /* * single line comment in multi-line configuration (wrong) */ /* single line comment (ok) */
注释时使用12个缩进(12 * 4个空格)偏移量。如果语句大于12个缩进，将注释4-空格对齐(下面的例子)到下一个可用缩进
void my_func(void) { char a, b; a = call_func_returning_char_a(a); /* this is comment with 12*4 spaces indent from beginning of line */ b = call_func_returning_char_a_but_func_name_is_very_long(a); /* this is comment, aligned to 4-spaces indent */ }
04 函数定义的规则
每个可以从模块外部访问的函数都必须包含函数原型(或声明)
函数名必须小写，可以用下划线_分隔。（这个原则好像因人而异）
/* ok */ void my_func(void); void myfunc(void); /* wrong */ void myfunc(void); void myfunc();
当函数返回指针时，将星号对齐到返回类型
/* ok */ const char* my_func(void); my_struct_t* my_func(int32_t a, int32_t b); /* wrong */ const char *my_func(void); my_struct_t * my_func(void);
对齐所有的功能原型(使用相同/相似的功能)以提高可读性
/* ok, function names aligned */ void set(int32_t a); my_type_t get(void); my_ptr_t* get_ptr(void); /* wrong */ void set(int32_t a); const char * get(void);
函数实现必须在单独的行中包含返回类型和可选的其他关键字
/* ok */ int32_t foo(void) { return 0; } /* ok */ static const char* get_string(void) { return hello world! ; } /* wrong */ int32_t foo(void) { return 0; }
5 变量相关的规则
使变量名全部小写，下划线_字符可选
/* ok */ int32_t a; int32_t my_var; int32_t myvar; /* wrong */ int32_t a; int32_t myvar; int32_t myvar;
按类型将局部变量分组在一起
void foo(void) { int32_t a, b; /* ok */ char a; char b; /* wrong, char type already exists */ }
不要在第一个可执行语句之后声明变量
void foo(void) { int32_t a; a = bar(); int32_t b; /* wrong, there is already executable statement */ }
你可以在下一个缩进级别中声明新的变量
int32_t a, b; a = foo(); if (a) { int32_t c, d; /* ok, c and d are in if-statement scope */ c = foo(); int32_t e; /* wrong, there was already executable statement inside block */ }
用星号声明指针变量与类型对齐
/* ok */ char* a; /* wrong */ char *a; char * a;
当声明多个指针变量时，可以使用星号对变量名进行声明
/* ok */ char *p, *n;
6 结构、枚举类型定义
结构名或枚举名必须小写，单词之间有下划线_字符
结构或枚举可以包含typedef关键字
所有结构成员都必须小写
所有枚举成员必须是大写的
结构/枚举必须遵循doxygen文档语法
在声明结构体时，它可以使用以下三种不同的选项之一:
1. 当结构体仅用名称声明时，它的名称后不能包含_t后缀。
struct struct_name { char* a; char b; };
2. 当只使用typedef声明结构时，它的名称后面必须包含_t后缀。
typedef struct { char* a; char b; } struct_name_t;
3. 当结构用name和typedef声明时，它不能包含t作为基本名称，它必须在它的名称后面包含t后缀作为typedef部分。
typedef struct struct_name { char* a; char b; char c; } struct_name_t;
错误声明的例子及其建议的纠正：
/* a and b must be separated to 2 lines */ /* name of structure with typedef must include _t suffix */ typedef struct { int32_t a, b; } a; /* corrected version */ typedef struct { int32_t a; int32_t b; } a_t; /* wrong name, it must not include _t suffix */ struct name_t { int32_t a; int32_t b; }; /* wrong parameters, must be all uppercase */ typedef enum { my_enum_testa, my_enum_testb, } my_enum_t;
在声明时初始化结构时，使用c99初始化风格
/* ok */ a_t a = { .a = 4, .b = 5, }; /* wrong */ a_t a = {1, 2};
当为函数句柄引入new typedef时，使用_fn后缀
/* function accepts 2 parameters and returns uint8_t */ /* name of typedef has `_fn` suffix */ typedef uint8_t (*my_func_typedef_fn)(uint8_t p1, const char* p2);
07 复合语句规则
每个复合语句必须包括左花括号和右花括号，即使它只包含1个嵌套语句
每个复合语句必须包含单个缩进;嵌套语句时，每个嵌套包含1个缩进大小
/* ok */ if (c) { do_a(); } else { do_b(); } /* wrong */ if (c) do_a(); else do_b(); /* wrong */ if (c) do_a(); else do_b();
在if或if-else-if语句的情况下，else必须与第一条语句的右括号在同一行
/* ok */ if (a) { } else if (b) { } else { } /* wrong */ if (a) { } else { } /* wrong */ if (a) { } else { }
在do-while语句的情况下，while部分必须与do部分的右括号在同一行
/* ok */ do { int32_t a; a = do_a(); do_b(a); } while (check()); /* wrong */ do { /* ... */ } while (check()); /* wrong */ do { /* ... */ } while (check());
每一个开括号都需要缩进
if (a) { do_a(); } else { do_b(); if (c) { do_c(); } }
不要做没有花括号的复合语句，即使是单个语句。下面的例子展示了一些不好的做法
if (a) do_b(); else do_c(); if (a) do_a(); else do_b();
空while循环、do-while循环或for循环必须包含花括号
/* ok */ while (is_register_bit_set()) {} /* wrong */ while (is_register_bit_set()); while (is_register_bit_set()) { } while (is_register_bit_set()) { }
如果while(或for、do-while等)为空(嵌入式编程中也可能是这种情况)，请使用空的单行括号
/* wait for bit to be set in embedded hardware unit uint32_t* addr = hw_periph_register_addr; /* wait bit 13 to be ready */ while (*addr & (1 << 13)) {} /* ok, empty loop contains no spaces inside curly brackets */ while (*addr & (1 << 13)) { } /* wrong */ while (*addr & (1 << 13)) { /* wrong */ } while (*addr & (1 << 13)); /* wrong, curly brackets are missing. can lead to compiler warnings or unintentional bugs */
尽量避免在循环块内递增变量，参见示例
/* not recommended */ int32_t a = 0; while (a < 10) { . .. ... ++a; } /* better */ for (size_t a = 0; a < 10; ++a) { } /* better, if inc may not happen in every cycle */ for (size_t a = 0; a < 10; ) { if (...) { ++a; } }
8 分支语句规则
为每个case语句添加单个缩进
使用额外的单缩进break语句在每个case或default
/* ok, every case has single indent */ /* ok, every break has additional indent */ switch (check()) { case 0: do_a(); break; case 1: do_b(); break; default: break; } /* wrong, case indent missing */ switch (check()) { case 0: do_a(); break; case 1: do_b(); break; default: break; } /* wrong */ switch (check()) { case 0: do_a(); break; /* wrong, break must have indent as it is under case */ case 1: do_b(); /* wrong, indent under case is missing */ break; default: break; }
总是包含default语句
/* ok */ switch (var) { case 0: do_job(); break; default: break; } /* wrong, default is missing */ switch (var) { case 0: do_job(); break; }
如果需要局部变量，则使用花括号并在里面放入break语句。将左花括号放在case语句的同一行
switch (a) { /* ok */ case 0: { int32_t a, b; char c; a = 5; /* ... */ break; } /* wrong */ case 1: { int32_t a; break; } /* wrong, break shall be inside */ case 2: { int32_t a; } break; }
9 宏和预处理指令
总是使用宏而不是文字常量，特别是对于数字
所有的宏必须是全大写的，并带有下划线_字符(可选)，除非它们被明确标记为function，将来可能会被常规函数语法替换
/* ok */ #define my_macro(x) ((x) * (x)) /* wrong */ #define square(x) ((x) * (x))
总是用圆括号保护输入参数
/* ok */ #define min(x, y) ((x) < (y) ? (x) : (y)) /* wrong */ #define min(x, y) x < y ? x : y
总是用括号保护最终的宏计算
/* wrong */ #define min(x, y) (x) < (y) ? (x) : (y) #define sum(x, y) (x) + (y) /* imagine result of this equation using wrong sum implementation */ int32_t x = 5 * sum(3, 4); /* expected result is 5 * 7 = 35 */ int32_t x = 5 * (3) + (4); /* it is evaluated to this, final result = 19 which is not what we expect */ /* correct implementation */ #define min(x, y) ((x) px = (x); (p)->py = (y) /* 2 statements. last one should not implement semicolon */ set_point(&p, 3, 4); /* set point to position 3, 4. this evaluates to... */ (&p)->px = (3); (&p)->py = (4); /* ... to this. in this example this is not a problem. */ /* consider this ugly code, however it is valid by c standard (not recommended) */ if (a) /* if a is true */ if (b) /* if b is true */ set_point(&p, 3, 4);/* set point to x = 3, y = 4 */ else set_point(&p, 5, 6);/* set point to x = 5, y = 6 */ /* evaluates to code below. do you see the problem? */ if (a) if (b) (&p)->px = (3); (&p)->py = (4); else (&p)->px = (5); (&p)->py = (6); /* or if we rewrite it a little */ if (a) if (b) (&p)->px = (3); (&p)->py = (4); else (&p)->px = (5); (&p)->py = (6); /* * ask yourself a question: to which `if` statement `else` keyword belongs? * * based on first part of code, answer is straight-forward. to inner `if` statement when we check `b` condition * actual answer: compilation error as `else` belongs nowhere */ /* better and correct implementation of macro */ #define set_point(p, x, y) do { (p)->px = (x); (p)->py = (y); } while (0) /* 2 statements. no semicolon after while loop */ /* or even better */ #define set_point(p, x, y) do { /* backslash indicates statement continues in new line */ (p)->px = (x); (p)->py = (y); } while (0) /* 2 statements. no semicolon after while loop */ /* now original code evaluates to */ if (a) if (b) do { (&p)->px = (3); (&p)->py = (4); } while (0); else do { (&p)->px = (5); (&p)->py = (6); } while (0); /* every part of `if` or `else` contains only `1` inner statement (do-while), hence this is valid evaluation */ /* to make code perfect, use brackets for every if-ifelse-else statements */ if (a) { /* if a is true */ if (b) { /* if b is true */ set_point(&p, 3, 4);/* set point to x = 3, y = 4 */ } else { set_point(&p, 5, 6);/* set point to x = 5, y = 6 */ } }
不缩进子语句内#if语句
/* ok */ #if defined(xyz) #if defined(abc) /* do when abc defined */ #endif /* defined(abc) */ #else /* defined(xyz) */ /* do when xyz not defined */ #endif /* !defined(xyz) */ /* wrong */ #if defined(xyz) #if defined(abc) /* do when abc defined */ #endif /* defined(abc) */ #else /* defined(xyz) */ /* do when xyz not defined */ #endif /* !defined(xyz) */ 文档
文档化的代码允许doxygen解析和通用的html/pdf/latex输出，因此正确地执行是非常重要的。
对变量、函数和结构/枚举使用doxygen支持的文档样式
经常使用作为doxygen，不要使用@
始终使用5x4空格(5个制表符)作为文本行开始的偏移量
/** * rief holds pointer to first entry in linked list * beginning of this text is 5 tabs (20 spaces) from beginning of line */ static type_t* list;
每个结构/枚举成员都必须包含文档
注释的开头使用12x4空格偏移量
/** * rief this is point struct * ote this structure is used to calculate all point * related stuff */ typedef struct { int32_t x; /*!< point x coordinate */ int32_t y; /*!< point y coordinate */ int32_t size; /*!< point size. since comment is very big, you may go to next line */ } point_t; /** * rief point color enumeration */ typedef enum { color_red, /*!< red color. this comment has 12x4 spaces offset from beginning of line */ color_green, /*!< green color */ color_blue, /*!< blue color */ } point_color_t;
函数的文档必须在函数实现中编写(通常是源文件)
函数必须包括简要和所有参数文档
如果每个参数分别为in或out输入和输出，则必须注意
如果函数返回某个值，则必须包含返回形参。这不适用于void函数
函数可以包含其他doxygen关键字，如note或warning
在参数名和描述之间使用冒号:
/** * rief sum `2` numbers * param[in] a: first number * param[in] b: second number * return sum of input values */ int32_t sum(int32_t a, int32_t b) { return a + b; } /** * rief sum `2` numbers and write it to pointer * ote this function does not return value, it stores it to pointer instead * param[in] a: first number * param[in] b: second number * param[out] result: output variable used to save result */ void void_sum(int32_t a, int32_t b, int32_t* result) { *result = a + b; }
如果函数返回枚举的成员，则使用ref关键字指定哪个成员
/** * rief my enumeration */ typedef enum { my_err, /*!< error value */ my_ok /*! null)
/** * rief get data from input array * param[in] in: input data * return pointer to output data on success, `null` otherwise */ const void * get_data(const void* in) { return in; }
宏的文档必须包括hideinitializer doxygen命令
/** * rief get minimal value between `x` and `y` * param[in] x: first value * param[in] y: second value * return minimal value between `x` and `y` * hideinitializer */ #define min(x, y) ((x)
头文件必须包含保护符#ifndef
头文件必须包含c++检查
在c++检查之外包含外部头文件
首先用stl c文件包含外部头文件，然后是应用程序自定义文件
头文件必须包含其他所有头文件，以便正确编译，但不能包含更多头文件(如果需要，.c应该包含其余的头文件)
头文件必须只公开模块公共变量/类型/函数
在头文件中使用extern作为全局模块变量，稍后在源文件中定义它们
/* file.h ... */ #ifndef ... extern int32_t my_variable; /* this is global variable declaration in header */ #endif /* file.c ... */ int32_t my_variable; /* actually defined in source */
不要把.c文件包含在另一个.c文件中
.c文件应该首先包含相应的.h文件，然后是其他文件，除非另有明确的必要
在头文件中不包含模块私有声明
头文件示例(示例中没有license)
/* license comes here */ #ifndef template_hdr_h #define template_hdr_h /* include headers */ #ifdef __cplusplus extern c { #endif /* __cplusplus */ /* file content here */ #ifdef __cplusplus } #endif /* __cplusplus */ #endif /* template_hdr_h */
美国有近8%的人表示他们计划在未来购买数字货币
怎样用声音控制RGBLED的颜色
华为全面屏手机新专利将要把听筒设置在屏幕内
高可靠低时延通信技术专利预警分析报告
小米MIX 2S相机评测机“双核对焦”详解
嵌入式C编码需要遵循的规范有哪些？
艾法斯推出支持DC-HSUPA的TM500移动测试终端
基于TCP应用层协议
苹果更新iOS10.2正式版！值得升级吗？看果粉吐槽
京东方全系列8K超高清显示屏助力央视实现全球首次春晚8K超高清直播
接近开关的工作原理是什么
两岸产业优势互补携手共创IC封测新局
5G为何这么快？得从这五大发明说起
关于非洲猪瘟检测器技术参数的详细介绍
发展国产电动机伺服有前途
高压线束零部件——连接器
为什么46家外企联手施压阻止中国出台一部法律
新品速递丨Brad M12 电源 L-Code连接器系统
浅谈电动调节阀，它的特性是什么
荣耀Magic2怎么样 到底值不值得买
编写代码时最重要的一条规则是：检查周围的代码并尝试模仿它。
作为维护人员，如果收到的补丁明显与周围代码的编码风格不同，这是令人沮丧的。这是不尊重人的，就像某人穿着泥泞的鞋子走进一间一尘不染的房子。
因此，无论本文推荐的是什么，如果已经编写了代码并且您正在对其进行修补，请保持其当前的样式一致，即使它不是您最喜欢的样式。
2 一般性的规则
这里列出了最明显和最重要的一般规则。在你继续阅读其他章节之前，请仔细检查它们。
使用c99标准
不使用制表符，而是使用空格
每个缩进级别使用4个空格
在关键字和左括号之间使用一个空格
在函数名和左括号之间不要使用空格
int32_t a = sum(4, 3); /* ok */ int32_t a = sum (4, 3); /* wrong */
不要在变量/函数/宏/类型中使用_或前缀。这是为c语言本身保留的
对于严格的模块私有函数，使用prv_ name前缀
对于包含下划线_ char的变量/函数/宏/类型，只能使用小写字母
左花括号总是与关键字(for, while, do, switch, if，…)在同一行
size_t i; for (i = 0; i < 5; ++i) { /* ok */ } for (i = 0; i < 5; ++i){ /* wrong */ } for (i = 0; i < 5; ++i) /* wrong */ { }
在比较操作符和赋值操作符之前和之后使用单个空格
int32_t a; a = 3 + 4; /* ok */ for (a = 0; a < 5; ++a) /* ok */ a=3+4; /* wrong */ a = 3+4; /* wrong */ for (a=0;a<5;++a) /* wrong */
每个逗号后用单空格
func_name(5, 4); /* ok */ func_name(4,3); /* wrong */
不要初始化静态和全局变量为0(或null)，让编译器为您做
static int32_t a; /* ok */ static int32_t b = 4; /* ok */ static int32_t a = 0; /* wrong */ void my_func(void) { static int32_t* ptr;/* ok */ static char abc = 0;/* wrong */ }
在同一行中声明所有相同类型的局部变量
void my_func(void) { char a; /* ok */ char b; /* wrong, variable with char type already exists */ char a, b; /* ok */ }
按顺序声明局部变量
i. 自定义结构和枚举
ii. 整数类型，更宽的无符号类型优先
iii. 单/双浮点
int my_func(void) { /* 1 */ my_struct_t my; /* first custom structures */ my_struct_ptr_t* p; /* pointers too */ /* 2 */ uint32_t a; int32_t b; uint16_t c; int16_t g; char h; /* ... */ /* 3 */ double d; float f; }
总是在块的开头声明局部变量，在第一个可执行语句之前
在for循环中声明计数器变量
/* ok */ for (size_t i = 0; i < 10; ++i) /* ok, if you need counter variable later */ size_t i; for (i = 0; i < 10; ++i) { if (...) { break; } } if (i * 10) { } /* wrong */ size_t i; for (i = 0; i < 10; ++i) ...
避免在声明中使用函数调用来赋值变量，除了单个变量
void a(void) { /* avoid function calls when declaring variable */ int32_t a, b = sum(1, 2); /* use this */ int32_t a, b; b = sum(1, 2); /* this is ok */ uint8_t a = 3, b = 4; }
除了char、float或double之外，始终使用stdint.h标准库中声明的类型。例如，8位的uint8_t等
不要使用stdbool.h库。分别使用1或0表示真或假
/* ok */ uint8_t status; status = 0; /* wrong */ #include bool status = true;
永远不要与真实相比较。例如，使用if(check_func()){…}替换if (check_func() * 1)
总是将指针与空值进行比较
void* ptr; /* ... */ /* ok, compare against null */ if (ptr * null || ptr != null) { } /* wrong */ if (ptr || !ptr) { }
总是使用前增量(和递减)，而不是后增量(和递减)
int32_t a = 0; ... a++; /* wrong */ ++a; /* ok */ for (size_t j = 0; j 0) /* ok, length is treated as counter variable containing multi values, not only 0 or 1 */ if (length * 0) /* ok, length is treated as counter variable containing multi values, not only 0 or 1 */ if (is_ok) /* ok, variable is treated as boolean */ if (!is_ok) /* ok, -||- */ if (is_ok * 1) /* wrong, never compare boolean variable against 1! */ if (is_ok * 0) /* wrong, use ! for negative check */
对于注释，总是使用/* comment */，即使是单行注释
在头文件中总是包含带有extern关键字的c++检查
每个函数都必须包含doxygen-enabled注释，即使函数是静态的
使用英文名称/文本的函数，变量，注释
变量使用小写字母
如果变量包含多个名称，请使用下划线。force_redraw。不要使用forceredraw
对于c标准库的包含文件，请始终使用。例如，# include
对于自定义库，请始终使用。例如，# include“my_library.h”
当转换为指针类型时，总是将星号与类型对齐，例如。uint8_t* t = (uint8_t*)var_width_diff_type
始终尊重项目或库中已经使用的代码风格
3 注释相关的规则
不允许以//开头的注释。总是使用② comment */，即使是单行注释
对于多行注释，每行使用空格+星号
/* * this is multi-line comments, * written in 2 lines (ok) */ /** * wrong, use double-asterisk only for doxygen documentation */ /* * single line comment without space before asterisk (wrong) */ /* * single line comment in multi-line configuration (wrong) */ /* single line comment (ok) */
注释时使用12个缩进(12 * 4个空格)偏移量。如果语句大于12个缩进，将注释4-空格对齐(下面的例子)到下一个可用缩进
void my_func(void) { char a, b; a = call_func_returning_char_a(a); /* this is comment with 12*4 spaces indent from beginning of line */ b = call_func_returning_char_a_but_func_name_is_very_long(a); /* this is comment, aligned to 4-spaces indent */ }
04 函数定义的规则
每个可以从模块外部访问的函数都必须包含函数原型(或声明)
函数名必须小写，可以用下划线_分隔。（这个原则好像因人而异）
/* ok */ void my_func(void); void myfunc(void); /* wrong */ void myfunc(void); void myfunc();
当函数返回指针时，将星号对齐到返回类型
/* ok */ const char* my_func(void); my_struct_t* my_func(int32_t a, int32_t b); /* wrong */ const char *my_func(void); my_struct_t * my_func(void);
对齐所有的功能原型(使用相同/相似的功能)以提高可读性
/* ok, function names aligned */ void set(int32_t a); my_type_t get(void); my_ptr_t* get_ptr(void); /* wrong */ void set(int32_t a); const char * get(void);
函数实现必须在单独的行中包含返回类型和可选的其他关键字
/* ok */ int32_t foo(void) { return 0; } /* ok */ static const char* get_string(void) { return hello world! ; } /* wrong */ int32_t foo(void) { return 0; }
5 变量相关的规则
使变量名全部小写，下划线_字符可选
/* ok */ int32_t a; int32_t my_var; int32_t myvar; /* wrong */ int32_t a; int32_t myvar; int32_t myvar;
按类型将局部变量分组在一起
void foo(void) { int32_t a, b; /* ok */ char a; char b; /* wrong, char type already exists */ }
不要在第一个可执行语句之后声明变量
void foo(void) { int32_t a; a = bar(); int32_t b; /* wrong, there is already executable statement */ }
你可以在下一个缩进级别中声明新的变量
int32_t a, b; a = foo(); if (a) { int32_t c, d; /* ok, c and d are in if-statement scope */ c = foo(); int32_t e; /* wrong, there was already executable statement inside block */ }
用星号声明指针变量与类型对齐
/* ok */ char* a; /* wrong */ char *a; char * a;
当声明多个指针变量时，可以使用星号对变量名进行声明
/* ok */ char *p, *n;
6 结构、枚举类型定义
结构名或枚举名必须小写，单词之间有下划线_字符
结构或枚举可以包含typedef关键字
所有结构成员都必须小写
所有枚举成员必须是大写的
结构/枚举必须遵循doxygen文档语法
在声明结构体时，它可以使用以下三种不同的选项之一:
1. 当结构体仅用名称声明时，它的名称后不能包含_t后缀。
struct struct_name { char* a; char b; };
2. 当只使用typedef声明结构时，它的名称后面必须包含_t后缀。
typedef struct { char* a; char b; } struct_name_t;
3. 当结构用name和typedef声明时，它不能包含t作为基本名称，它必须在它的名称后面包含t后缀作为typedef部分。
typedef struct struct_name { char* a; char b; char c; } struct_name_t;
错误声明的例子及其建议的纠正：
/* a and b must be separated to 2 lines */ /* name of structure with typedef must include _t suffix */ typedef struct { int32_t a, b; } a; /* corrected version */ typedef struct { int32_t a; int32_t b; } a_t; /* wrong name, it must not include _t suffix */ struct name_t { int32_t a; int32_t b; }; /* wrong parameters, must be all uppercase */ typedef enum { my_enum_testa, my_enum_testb, } my_enum_t;
在声明时初始化结构时，使用c99初始化风格
/* ok */ a_t a = { .a = 4, .b = 5, }; /* wrong */ a_t a = {1, 2};
当为函数句柄引入new typedef时，使用_fn后缀
/* function accepts 2 parameters and returns uint8_t */ /* name of typedef has `_fn` suffix */ typedef uint8_t (*my_func_typedef_fn)(uint8_t p1, const char* p2);
07 复合语句规则
每个复合语句必须包括左花括号和右花括号，即使它只包含1个嵌套语句
每个复合语句必须包含单个缩进;嵌套语句时，每个嵌套包含1个缩进大小
/* ok */ if (c) { do_a(); } else { do_b(); } /* wrong */ if (c) do_a(); else do_b(); /* wrong */ if (c) do_a(); else do_b();
在if或if-else-if语句的情况下，else必须与第一条语句的右括号在同一行
/* ok */ if (a) { } else if (b) { } else { } /* wrong */ if (a) { } else { } /* wrong */ if (a) { } else { }
在do-while语句的情况下，while部分必须与do部分的右括号在同一行
/* ok */ do { int32_t a; a = do_a(); do_b(a); } while (check()); /* wrong */ do { /* ... */ } while (check()); /* wrong */ do { /* ... */ } while (check());
每一个开括号都需要缩进
if (a) { do_a(); } else { do_b(); if (c) { do_c(); } }
不要做没有花括号的复合语句，即使是单个语句。下面的例子展示了一些不好的做法
if (a) do_b(); else do_c(); if (a) do_a(); else do_b();
空while循环、do-while循环或for循环必须包含花括号
/* ok */ while (is_register_bit_set()) {} /* wrong */ while (is_register_bit_set()); while (is_register_bit_set()) { } while (is_register_bit_set()) { }
如果while(或for、do-while等)为空(嵌入式编程中也可能是这种情况)，请使用空的单行括号
/* wait for bit to be set in embedded hardware unit uint32_t* addr = hw_periph_register_addr; /* wait bit 13 to be ready */ while (*addr & (1 << 13)) {} /* ok, empty loop contains no spaces inside curly brackets */ while (*addr & (1 << 13)) { } /* wrong */ while (*addr & (1 << 13)) { /* wrong */ } while (*addr & (1 << 13)); /* wrong, curly brackets are missing. can lead to compiler warnings or unintentional bugs */
尽量避免在循环块内递增变量，参见示例
/* not recommended */ int32_t a = 0; while (a < 10) { . .. ... ++a; } /* better */ for (size_t a = 0; a < 10; ++a) { } /* better, if inc may not happen in every cycle */ for (size_t a = 0; a < 10; ) { if (...) { ++a; } }
8 分支语句规则
为每个case语句添加单个缩进
使用额外的单缩进break语句在每个case或default
/* ok, every case has single indent */ /* ok, every break has additional indent */ switch (check()) { case 0: do_a(); break; case 1: do_b(); break; default: break; } /* wrong, case indent missing */ switch (check()) { case 0: do_a(); break; case 1: do_b(); break; default: break; } /* wrong */ switch (check()) { case 0: do_a(); break; /* wrong, break must have indent as it is under case */ case 1: do_b(); /* wrong, indent under case is missing */ break; default: break; }
总是包含default语句
/* ok */ switch (var) { case 0: do_job(); break; default: break; } /* wrong, default is missing */ switch (var) { case 0: do_job(); break; }
如果需要局部变量，则使用花括号并在里面放入break语句。将左花括号放在case语句的同一行
switch (a) { /* ok */ case 0: { int32_t a, b; char c; a = 5; /* ... */ break; } /* wrong */ case 1: { int32_t a; break; } /* wrong, break shall be inside */ case 2: { int32_t a; } break; }
9 宏和预处理指令
总是使用宏而不是文字常量，特别是对于数字
所有的宏必须是全大写的，并带有下划线_字符(可选)，除非它们被明确标记为function，将来可能会被常规函数语法替换
/* ok */ #define my_macro(x) ((x) * (x)) /* wrong */ #define square(x) ((x) * (x))
总是用圆括号保护输入参数
/* ok */ #define min(x, y) ((x) < (y) ? (x) : (y)) /* wrong */ #define min(x, y) x < y ? x : y
总是用括号保护最终的宏计算
/* wrong */ #define min(x, y) (x) < (y) ? (x) : (y) #define sum(x, y) (x) + (y) /* imagine result of this equation using wrong sum implementation */ int32_t x = 5 * sum(3, 4); /* expected result is 5 * 7 = 35 */ int32_t x = 5 * (3) + (4); /* it is evaluated to this, final result = 19 which is not what we expect */ /* correct implementation */ #define min(x, y) ((x) px = (x); (p)->py = (y) /* 2 statements. last one should not implement semicolon */ set_point(&p, 3, 4); /* set point to position 3, 4. this evaluates to... */ (&p)->px = (3); (&p)->py = (4); /* ... to this. in this example this is not a problem. */ /* consider this ugly code, however it is valid by c standard (not recommended) */ if (a) /* if a is true */ if (b) /* if b is true */ set_point(&p, 3, 4);/* set point to x = 3, y = 4 */ else set_point(&p, 5, 6);/* set point to x = 5, y = 6 */ /* evaluates to code below. do you see the problem? */ if (a) if (b) (&p)->px = (3); (&p)->py = (4); else (&p)->px = (5); (&p)->py = (6); /* or if we rewrite it a little */ if (a) if (b) (&p)->px = (3); (&p)->py = (4); else (&p)->px = (5); (&p)->py = (6); /* * ask yourself a question: to which `if` statement `else` keyword belongs? * * based on first part of code, answer is straight-forward. to inner `if` statement when we check `b` condition * actual answer: compilation error as `else` belongs nowhere */ /* better and correct implementation of macro */ #define set_point(p, x, y) do { (p)->px = (x); (p)->py = (y); } while (0) /* 2 statements. no semicolon after while loop */ /* or even better */ #define set_point(p, x, y) do { /* backslash indicates statement continues in new line */ (p)->px = (x); (p)->py = (y); } while (0) /* 2 statements. no semicolon after while loop */ /* now original code evaluates to */ if (a) if (b) do { (&p)->px = (3); (&p)->py = (4); } while (0); else do { (&p)->px = (5); (&p)->py = (6); } while (0); /* every part of `if` or `else` contains only `1` inner statement (do-while), hence this is valid evaluation */ /* to make code perfect, use brackets for every if-ifelse-else statements */ if (a) { /* if a is true */ if (b) { /* if b is true */ set_point(&p, 3, 4);/* set point to x = 3, y = 4 */ } else { set_point(&p, 5, 6);/* set point to x = 5, y = 6 */ } }
不缩进子语句内#if语句
/* ok */ #if defined(xyz) #if defined(abc) /* do when abc defined */ #endif /* defined(abc) */ #else /* defined(xyz) */ /* do when xyz not defined */ #endif /* !defined(xyz) */ /* wrong */ #if defined(xyz) #if defined(abc) /* do when abc defined */ #endif /* defined(abc) */ #else /* defined(xyz) */ /* do when xyz not defined */ #endif /* !defined(xyz) */ 文档
文档化的代码允许doxygen解析和通用的html/pdf/latex输出，因此正确地执行是非常重要的。
对变量、函数和结构/枚举使用doxygen支持的文档样式
经常使用作为doxygen，不要使用@
始终使用5x4空格(5个制表符)作为文本行开始的偏移量
/** * rief holds pointer to first entry in linked list * beginning of this text is 5 tabs (20 spaces) from beginning of line */ static type_t* list;
每个结构/枚举成员都必须包含文档
注释的开头使用12x4空格偏移量
/** * rief this is point struct * ote this structure is used to calculate all point * related stuff */ typedef struct { int32_t x; /*!< point x coordinate */ int32_t y; /*!< point y coordinate */ int32_t size; /*!< point size. since comment is very big, you may go to next line */ } point_t; /** * rief point color enumeration */ typedef enum { color_red, /*!< red color. this comment has 12x4 spaces offset from beginning of line */ color_green, /*!< green color */ color_blue, /*!< blue color */ } point_color_t;
函数的文档必须在函数实现中编写(通常是源文件)
函数必须包括简要和所有参数文档
如果每个参数分别为in或out输入和输出，则必须注意
如果函数返回某个值，则必须包含返回形参。这不适用于void函数
函数可以包含其他doxygen关键字，如note或warning
在参数名和描述之间使用冒号:
/** * rief sum `2` numbers * param[in] a: first number * param[in] b: second number * return sum of input values */ int32_t sum(int32_t a, int32_t b) { return a + b; } /** * rief sum `2` numbers and write it to pointer * ote this function does not return value, it stores it to pointer instead * param[in] a: first number * param[in] b: second number * param[out] result: output variable used to save result */ void void_sum(int32_t a, int32_t b, int32_t* result) { *result = a + b; }
如果函数返回枚举的成员，则使用ref关键字指定哪个成员
/** * rief my enumeration */ typedef enum { my_err, /*!< error value */ my_ok /*! null)
/** * rief get data from input array * param[in] in: input data * return pointer to output data on success, `null` otherwise */ const void * get_data(const void* in) { return in; }
宏的文档必须包括hideinitializer doxygen命令
/** * rief get minimal value between `x` and `y` * param[in] x: first value * param[in] y: second value * return minimal value between `x` and `y` * hideinitializer */ #define min(x, y) ((x)
头文件必须包含保护符#ifndef
头文件必须包含c++检查
在c++检查之外包含外部头文件
首先用stl c文件包含外部头文件，然后是应用程序自定义文件
头文件必须包含其他所有头文件，以便正确编译，但不能包含更多头文件(如果需要，.c应该包含其余的头文件)
头文件必须只公开模块公共变量/类型/函数
在头文件中使用extern作为全局模块变量，稍后在源文件中定义它们
/* file.h ... */ #ifndef ... extern int32_t my_variable; /* this is global variable declaration in header */ #endif /* file.c ... */ int32_t my_variable; /* actually defined in source */
不要把.c文件包含在另一个.c文件中
.c文件应该首先包含相应的.h文件，然后是其他文件，除非另有明确的必要
在头文件中不包含模块私有声明
头文件示例(示例中没有license)
/* license comes here */ #ifndef template_hdr_h #define template_hdr_h /* include headers */ #ifdef __cplusplus extern c { #endif /* __cplusplus */ /* file content here */ #ifdef __cplusplus } #endif /* __cplusplus */ #endif /* template_hdr_h */
美国有近8%的人表示他们计划在未来购买数字货币
怎样用声音控制RGBLED的颜色
华为全面屏手机新专利将要把听筒设置在屏幕内
高可靠低时延通信技术专利预警分析报告
小米MIX 2S相机评测机“双核对焦”详解
嵌入式C编码需要遵循的规范有哪些？
艾法斯推出支持DC-HSUPA的TM500移动测试终端
基于TCP应用层协议
苹果更新iOS10.2正式版！值得升级吗？看果粉吐槽
京东方全系列8K超高清显示屏助力央视实现全球首次春晚8K超高清直播
接近开关的工作原理是什么
两岸产业优势互补携手共创IC封测新局
5G为何这么快？得从这五大发明说起
关于非洲猪瘟检测器技术参数的详细介绍
发展国产电动机伺服有前途
高压线束零部件——连接器
为什么46家外企联手施压阻止中国出台一部法律
新品速递丨Brad M12 电源 L-Code连接器系统
浅谈电动调节阀，它的特性是什么
荣耀Magic2怎么样 到底值不值得买