分享GitHub上一位老外的嵌入式C编码规范（收藏细读）

Posted 2021-06-29 卓晴

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了分享GitHub上一位老外的嵌入式C编码规范（收藏细读）相关的知识，希望对你有一定的参考价值。

简介：本文分析在头条上分享GitHub上一位老外的嵌入式C编码规范（收藏细读）：嵌入式大杂烩。

关键词： 嵌入式，C语句，编程规范

分享GitHub上一位老外的嵌入式C编码规范（收藏细读）

§01 最重要的规则

编写代码时最重要的一条规则是：检查周围的代码并尝试模仿它。

作为维护人员，如果收到的补丁明显与周围代码的编码风格不同，这是令人沮丧的。这是不尊重人的，就像某人穿着泥泞的鞋子走进一间一尘不染的房子。

因此，无论本文推荐的是什么，如果已经编写了代码并且您正在对其进行修补，请保持其当前的样式一致，即使它不是您最喜欢的样式。

§02 一般性的规则

这里列出了最明显和最重要的一般规则。在你继续阅读其他章节之前，请仔细检查它们。

使用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 <stdbool.h>
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 < 10; ++j) {}  /* OK */

总是使用size_t作为长度或大小变量
如果函数不应该修改指针所指向的内存，则总是使用const作为指针
如果不应该修改函数的形参或变量，则总是使用const

/* When d could be modified, data pointed to by d could not be modified */
void
my_func(const void* d) {

}

/* When d and data pointed to by d both could not be modified */
void
my_func(const void* const d) {

}

/* Not required, it is advised */
void
my_func(const size_t len) {

}

/* When d should not be modified inside function, only data pointed to by d could be modified */
void
my_func(void* const d) {

}

当函数可以接受任何类型的指针时，总是使用void *，不要使用uint8_t *。函数在实现时必须注意正确的类型转换

/*
 * To send data, function should not modify memory pointed to by `data` variable
 * thus `const` keyword is important
 *
 * To send generic data (or to write them to file)
 * any type may be passed for data,
 * thus use `void *`
 */
/* OK example */
void send_data(const void* data, size_t len) { /* OK */
    /* Do not cast `void *` or `const void *` */
    const uint8_t* d = data;/* Function handles proper type for internal usage */
}

void send_data(const void* data, int len) {    /* Wrong, not not use int */
}

总是使用括号和sizeof操作符
不要使用变长数组。使用动态内存分配代替标准C malloc和自由函数，或者如果库/项目提供了自定义内存分配，使用它的实现看看LwMEM，一个自定义内存管理库。

/* OK */
#include <stdlib.h>
void
my_func(size_t size) {
    int32_t* arr;
    arr = malloc(sizeof(*arr) * n); /* OK, Allocate memory */
    arr = malloc(sizeof *arr * n);  /* Wrong, brackets for sizeof operator are missing */
    if (arr == NULL) {
        /* FAIL, no memory */
    }

    free(arr);  /* Free memory after usage */
}

/* Wrong */
void
my_func(size_t size) {
    int32_t arr[size];  /* Wrong, do not use VLA */
}

总是将variable与0进行比较，除非它被视为布尔类型
永远不要将布尔处理的变量与0或1进行比较。用NOT(!)代替

size_t length = 5;  /* Counter variable */
uint8_t is_ok = 0;  /* Boolean-treated variable */
if (length)         /* Wrong, length is not treated as boolean */
if (length > 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 < stdlib.h >
对于自定义库，请始终使用""。例如，# include“my_library.h”
当转换为指针类型时，总是将星号与类型对齐，例如。uint8_t* t = (uint8_t*)var_width_diff_type
始终尊重项目或库中已经使用的代码风格

§03 注释相关的规则

不允许以//开头的注释。总是使用② 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!\\r\\n";
}

/* Wrong */
int32_t foo(void) {
    return 0;
}

§05 变量相关的规则

使变量名全部小写，下划线_字符可选

/* 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;

§06 结构、枚举类型定义

结构名或枚举名必须小写，单词之间有下划线_字符
结构或枚举可以包含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 *分享GitHub上一位老外的嵌入式C编码规范（收藏细读）
 分享GitHub上一位老外的嵌入式C编码规范（收藏细读）
 老外的嵌入式编程规范（值得一看）
 嵌入式软件-C语言笔试题
 老外为了在MacBook上玩原神，让M1支持了所有iOS应用 | Github每周精彩分享第一期
 C语言编码“注释”规范