代码风格指南 📜

遵循一致的代码风格是保障团队协作与代码可维护性的关键。以下为通用规范建议：

1. 命名规范

  • 变量名使用 snake_case（如 user_name）
  • 函数名使用 camelCase（如 calculateTotalPrice）
  • 常量名全大写（如 MAX_RETRIES）
  • 类名使用 PascalCase（如 DatabaseConnection）

2. 格式化规则

  • 缩进使用 4 个空格（⚠️ 避免使用 Tab）
  • 每行不超过 80 字符（超长时换行）
  • 引号统一使用双引号（" "）
  • 逗号后添加空格（如 key: "value" ,）

3. 注释与文档

  • 函数需添加 docstring（如 """函数用途描述"""）
  • 复杂逻辑旁添加行内注释（# 避免此处出现魔法数字）
  • 保持注释与代码同步更新 ✅

4. 扩展阅读

想了解更多？可参考本站的 贡献指南 或 代码标准。

code_editor

📌 保持代码简洁优雅，让维护者如沐春风 🌸