本指南旨在帮助开发者统一编码规范，提升代码可读性与协作效率。了解更多 → /code-style/opensource

命名规范 📦

  • 变量名：使用小驼峰式（如 userName），避免拼音或缩写（如 usrNm）
  • 函数名：动词开头，名词结尾（如 calculateTotalPrice）
  • 常量名：全大写，下划线分隔（如 MAX_RETRY_COUNT）
  • 类名：大驼峰式（如 UserManager）

格式化规范 📏

  • 缩进：统一使用 4 个空格（⚠️ 禁止使用 Tab）
  • 行长度：不超过 80 字符（建议 72 字符）
  • 代码块：使用 markdown 或 code 包裹
  • 注释：关键逻辑需添加注释（如 // 防止空指针异常）

注释规范 📝

  • 函数注释需包含：功能描述、参数说明、返回值类型
  • 避免冗余注释（如 // 设置变量a为1）
  • 使用中文注释，保持简洁明了

版本控制规范 ⚙️

  • 提交信息遵循 Conventional Commits
  • 分支命名：feature/xxx、fix/xxx、hotfix/xxx
  • 合并前检查：代码格式、单元测试覆盖率、文档同步
代码风格指南

扩展阅读 📚