Skip to content

1. C/C++ 代码格式化

在嵌入式开发中,C/C++ 是非常常用的语言,以下是一些格式化要点和工具:

要点

  • 缩进:一般使用 4 个空格或者一个制表符进行缩进,使代码层次结构清晰。例如:
c
if (condition) {
    // 执行语句
    statement1;
    statement2;
}
  • 大括号位置:大括号的位置有多种风格,常见的是 K&R 风格(行尾开始大括号)和 Allman 风格(大括号单独一行)。如 K&R 风格:
c
void function() {
    // 函数体
}

Allman 风格:

c
void function()
{
    // 函数体
}
  • 空格使用:在运算符、逗号、分号前后适当使用空格,增强代码可读性。例如:
c
int sum = a + b;

工具

  • Clang - Format:这是一个强大的 C/C++ 代码格式化工具,可以根据配置文件(如 .clang-format)对代码进行格式化。例如,使用以下命令对 example.c 文件进行格式化:
bash
clang-format -i example.c
  • Astyle:也是一个常用的 C/C++ 代码格式化工具,支持多种代码风格。使用示例:
bash
astyle --style=kr example.c

2. Python 代码格式化

在嵌入式系统的脚本编写或者某些开发环节可能会用到 Python,Python 有严格的缩进规则。

要点

  • 缩进:Python 使用 4 个空格进行缩进,且缩进决定代码块的层次。例如:
python
if condition:
    # 代码块
    statement1
    statement2
  • 行长度:建议每行代码长度不超过 79 个字符,过长的代码可以使用括号进行换行。例如:
python
result = (long_variable_name1 +
          long_variable_name2)

工具

  • Black:是一个无配置的 Python 代码格式化工具,它会按照自己的规则对代码进行格式化。使用方法:
bash
black example.py
  • Autopep8:可以将 Python 代码格式化为符合 PEP 8 规范的代码。使用示例:
bash
autopep8 --in-place example.py

3. 汇编代码格式化

在嵌入式底层开发中,汇编代码也较为常见。

要点

  • 标签和指令对齐:标签和指令要有清晰的对齐方式,便于阅读和调试。例如:
asm
START:
    MOV R0, #10 ; 将立即数 10 移动到寄存器 R0
    ADD R1, R0, #2 ; R1 = R0 + 2
  • 注释使用:在关键指令处添加注释,解释指令的功能和作用。

工具

汇编代码的格式化工具相对较少,有些集成开发环境(IDE)如 Keil、IAR 等会提供一定的代码格式化功能,可以在 IDE 中查找相关设置进行代码格式化。