命名规范 ✅

  • 变量名：使用有意义的英文小写，如 userName 而非 user_name 或 UserName
    命名规范
  • 函数名：动词开头，如 calculateTotal() 而非 calcTotal() 或 CalculateTotal()
    函数命名
  • 常量名：全大写加下划线，如 MAX_USERS = 100
    常量命名

代码结构 📁

  • 保持函数单一职责，避免 God Object
  • 使用空行分隔逻辑块，如：
    def main():
    # 初始化
    init()
    
    # 核心逻辑
    process()
    
    # 清理
    cleanup()
    代码结构

注释习惯 📝

  • 文档注释：使用 /** ... */ 描述函数目的与参数
  • 行内注释：用 // 解释复杂逻辑，如：
    int result = calculate(3, 4); // 使用勾股定理计算斜边
    注释规范

版本控制 📊

  • 每次提交需包含：
    1. feat: 新功能
    2. fix: 修复漏洞
    3. docs: 文档更新
  • 推荐使用 语义化版本号 系统

扩展阅读 🔍

深入理解代码规范的进阶指南