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

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. 单/双浮点

#pgc-card .pgc-card-href { text-decoration: none; outline: none; display: block; width: 100%; height: 100%; } #pgc-card .pgc-card-href:hover { text-decoration: none; } /*pc 样式*/ .pgc-card { box-sizing: border-box; height: 164px; border: 1px solid #e8e8e8; position: relative; padding: 20px 94px 12px 180px; overflow: hidden; } .pgc-card::after { content: " "; display: block; border-left: 1px solid #e8e8e8; height: 120px; position: absolute; right: 76px; top: 20px; } .pgc-cover { position: absolute; width: 162px; height: 162px; top: 0; left: 0; background-size: cover; } .pgc-content { overflow: hidden; position: relative; top: 50%; -webkit-transform: translateY(-50%); transform: translateY(-50%); } .pgc-content-title { font-size: 18px; color: #222; line-height: 1; font-weight: bold; overflow: hidden; text-overflow: ellipsis; white-space: nowrap; } .pgc-content-desc { font-size: 14px; color: #444; overflow: hidden; text-overflow: ellipsis; padding-top: 9px; overflow: hidden; line-height: 1.2em; display: -webkit-inline-box; -webkit-line-clamp: 2; -webkit-box-orient: vertical; } .pgc-content-price { font-size: 22px; color: #f85959; padding-top: 18px; line-height: 1em; } .pgc-card-buy { width: 75px; position: absolute; right: 0; top: 50px; color: #406599; font-size: 14px; text-align: center; } .pgc-buy-text { padding-top: 10px; } .pgc-icon-buy { height: 23px; width: 20px; display: inline-block; background: url(https://lf6-cdn-tos.bytescm.com/obj/cdn-static-resource/pgc/v2/pgc_tpl/static/image/commodity_buy_f2b4d1a.png); }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;}

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

• 不要使用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 */voidmy_func(const void* d) {}/* When d and data pointed to by d both could not be modified */voidmy_func(const void* const d) {}/* Not required, it is advised */voidmy_func(const size_t len) {}/* When d should not be modified inside function, only data pointed to by d could be modified */voidmy_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, notnot use int */}

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

/* OK */#include <stdlib.h>voidmy_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 */voidmy_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 in2 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_tfoo(void) { return0;}/* OK */static const char*get_string(void) { return"Hello world!\r\n";}/* Wrong */int32_t foo(void) { return0;}

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文档语法

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

/* 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) {} elseif (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());

用户评论

Edinburgh°南空

我在阅读了该文章后，了解到老外在进行嵌入式编程时确实有一些不同的规范。首先就是代码注释，他们更强调详细且结构化的注释说明。

    有20位网友表示赞同！

雁過藍天

我发现一个有趣点是，老外的嵌入式工程师喜欢使用固定的命名规则，并严格遵循缩进和空格的标准布局。

    有14位网友表示赞同！

幸好是你

这篇文章还提到了语言选择上的异同，在嵌入式领域中，美国人和欧洲人可能会更偏好特定的技术栈。

    有7位网友表示赞同！

米兰

对于错误处理和异常管理的方式上，我注意到他们的实践更加规范化且有着详细的文档支持。

    有15位网友表示赞同！

拽年很骚

在代码审查流程方面，文章指出了老外可能执行得更为严谨和集中化，以保证代码质量。

    有7位网友表示赞同！

▼遗忘那段似水年华

文中提到的配置管理工具使用也有不同点，一些老国外部采用的技术可能是我们不常见的。

    有5位网友表示赞同！

陌離

关于版本控制系统的选择，我发现某些外国软件公司更加青睐特定系统，这使得团队间的协作更为高效。

    有5位网友表示赞同！

苏莫晨

在文档构建和维护上，原文提出了一些他们较为看重的自动化工具和技术实践。

    有12位网友表示赞同！

不离我

讨论了测试框架和测试驱动开发（TDD）的集成使用，在这一方面他们的实践更为系统化。

    有13位网友表示赞同！

花花世界总是那么虚伪﹌

对于库和框架的选择上，文章揭示了某些老外在嵌入式编程中更倾向于特定的技术资源。

    有17位网友表示赞同！

枫无痕

我了解到他们对软硬件协同设计及优化过程有着独特的规定和流程规划方法。

    有8位网友表示赞同！

棃海

原文特别提到了在调试方法上的差异，比如使用特定的工具环境或工作流程来提高效率。

    有7位网友表示赞同！

何年何念

对于软件安全方面的标准和实践上，老外的一些做法可能更加强调最小化风险。

    有9位网友表示赞同！

孤岛晴空

他们对于模块化编程、API设计和接口规范的规定，让我发现了不少值得借鉴之处。

    有20位网友表示赞同！

巷陌繁花丶

文中提及的一个关键点是版本控制中的分支管理策略，在这一领域有一些独特的方法。

    有15位网友表示赞同！

念旧是个瘾。

在部署和发布流程上，文章详细描述了他们的自动化构建与发布框架可能与我们有所不同。

    有6位网友表示赞同！

见朕骑妓的时刻

对于代码质量度量的工具和技术选择上，老外来做决策时可能会遵循一套特定的准则。

    有13位网友表示赞同！

青衫故人

原文还提到了他们在维护代码库方面的一些特殊技巧，如代码审查和重构的最佳实践。

    有6位网友表示赞同！

旧爱剩女

我了解到在项目管理上，他们可能使用了与我们不同的敏捷或迭代开发方法。

    有19位网友表示赞同！