本指南为OSS项目C支持文档核心规范部分,包含代码规范、命名规则等技术细节
🧩 核心规范
- 缩进:统一使用4个空格(
- 括号:所有控制结构必须使用大括号(
{}
),即使单行语句 - 空格:运算符两侧必须有空格,如
int a = 5;
,禁用int a=5;
形式
📌 命名约定
类型 | 命名规范 | 示例 |
---|---|---|
变量 | 全小写,下划线分隔 | max_value |
函数 | �单词小写,驼峰命名 | calculate_sum() |
常量 | 全大写,下划线分隔 | MAX_BUFFER_SIZE |
📝 注释规范
- 每个函数必须有文档注释(
/** ... */
) - 关键逻辑需添加行内注释(
// 说明
) - 示例:
/** * 计算数组平均值 * @param arr 输入数组 * @param len 数组长度 * @return 平均值 */ float calc_avg(float* arr, int len) { // 防止空指针 if (!arr) return 0.0f; // 计算总和 float sum = 0.0f; for (int i = 0; i < len; i++) { sum += arr[i]; } // 返回平均值 return sum / len; }
🛠 格式化工具
建议使用以下工具保持代码一致性:
- Clang-Format(推荐配置:
.clang-format
) - Uncrustify(配置示例:
uncrustify.cfg
)