本指南旨在为开发者提供统一的代码风格规范，确保项目代码的可读性与可维护性。如需了解更多实践技巧，请访问 /zh/docs/coding-standards/best-practices

1. 代码风格规范 🧹

  • 缩进：使用4个空格（或对应语言的默认缩进方式）
  • 空格：运算符两侧需保留空格，例如 int a = 10;
  • 括号：采用K&R风格（左括号在行首） 
    if (condition) {
    // code
}
    代码格式化工具

2. 命名规范 📜

  • 变量名：使用小驼峰（如 userName）或下划线分隔（如 user_name）
  • 常量名：全大写 + 下划线（如 MAX_VALUE）
  • 函数名：动词开头 + 小驼峰（如 calculateSum）
    命名规范示意图

3. 注释规范 📝

  • 函数注释：需包含功能说明、参数及返回值（如 // 计算两个数的和，参数a和b为整数，返回a + b）
  • 关键逻辑注释：使用简洁的中文说明，避免冗余
    注释规范示意图

4. 扩展阅读 📚

保持代码整洁，让团队协作更高效 💡