本文档遵循项目C的代码标准,点击此处查看开发指南扩展阅读
一、命名规范 📌
- 变量名:使用
snake_case
,如user_name
- 函数名:使用
camelCase
,如calculateTotalPrice
- 常量名:全大写加下划线,如
MAX_RETRY_COUNT
- 文件名:小写加下划线,如
data_utils.c
二、代码结构 🏗️
- 每个模块需包含头文件注释
- 函数逻辑分块,使用
/* ... */
包裹 - 错误处理统一返回
errno
值 - 代码缩进使用4个空格,禁止使用Tab
三、注释要求 📝
- 关键逻辑需添加
TODO
标记 - 函数参数说明使用
@param
格式 - 模块功能描述使用
@module
标签 - 代码变更记录使用
@change
标注
四、安全规范 🔒
- 输入数据需进行
sanitization
处理 - 使用
const
修饰不修改的变量 - 禁止直接使用
system()
函数 - 线程安全函数需标注
thread_safe
点击此处可查看项目C开发规范的完整说明,了解更多技术细节。