本文档旨在为开发者提供统一的代码编写标准，确保项目可维护性与协作效率。建议结合开发实践手册深入了解。

1. 代码格式规范 🧹

  • 缩进：使用 2 个空格或 Tab（统一为 2 空格）
  • 行长度：不超过 80 字符，超过时使用折行（\\）保持逻辑连贯
  • 空行：函数间保留 2 行空隙，类定义前后保留 1 行空隙
  • 括号：if/for/while语句采用 K&R 风格（if (condition)）
code_formatting

2. 命名规范 📌

类型 示例 规则
变量 user_name 小写字母+下划线，避免保留字
函数 calculate_total() 动词开头，参数名需清晰
类名 DatabaseManager 首字母大写，复合词需大写
variable_naming

3. 注释规范 📝

  • 函数注释：需包含功能描述、参数说明、返回值类型（@return）
  • 关键逻辑：复杂算法需添加 // TODO: 需要优化 标记
  • 注释语言：与代码语言一致，避免混合使用英文/中文
code_commenting

4. 错误处理规范 ⚠️

  • 异常捕获：建议使用 try/catch 结构，避免 except 捕获所有异常
  • 日志记录：严重错误需调用 log.error()，普通警告使用 log.warn()
  • 返回值：函数需明确 null 或默认值的处理逻辑

了解更多开发规范
查看代码示例仓库