一、代码风格规范
1. 命名规则
变量命名:采用小写字母加下划线的组合,例如current_speed
、sensor_value
。避免使用单个字符命名,除非是循环计数器(如i
、j
)。
函数命名:使用动词 + 名词的结构,清晰表达函数功能,如calculate_average()
、init_gpio()
。
宏与常量命名:全部大写,单词间用下划线分隔,如MAX_BUFFER_SIZE
、ADC_REF_VOLTAGE
。
2. 代码缩进与格式
- 采用 4 个空格缩进(而非 Tab),确保代码在不同编辑器中显示一致。
- 大括号位置:左大括号放在语句末尾,右大括号单独一行,例如:
if (condition) {
// 执行语句
} else {
// 执行语句
}
- 每行代码长度限制在 80-100 个字符,长表达式应适当换行。
3. 注释规范
- 函数头部注释:说明函数功能、参数、返回值及注意事项,例如:
/**
* @brief 初始化GPIO引脚
* @param