代码规范

📌 代码规范指南

代码规范是软件开发中确保代码质量、可维护性和团队协作效率的重要基础。良好的规范能显著降低开发成本，提升代码的可读性与扩展性。以下是核心规范建议：

1. 命名规范

   • 变量/函数名使用 snake_case（中文环境推荐）
   • 类名使用 PascalCase
   • 常量名全大写 UPPER_CASE
   • 避免使用模糊缩写（如 idx 应改为 index）

2. 格式统一

   • 缩进使用 4 个空格（或 Tab）
   • 每行不超过 80 字符（现代编辑器可适当放宽）
   • 括号与代码块保持一致的对齐方式

3. 注释规范

   • 关键逻辑需添加注释（如算法、业务规则）
   • 避免过度注释（如简单赋值可省略）
   • 使用文档注释（如 JSDoc）说明接口用途

4. 错误处理

   • 异常需明确捕获并记录日志
   • 返回错误码时遵循统一标准（如 200-500 业务码，500-600 系统码）
   • 避免空指针或未初始化变量

5. 代码复用

   • 抽象通用逻辑为独立函数/模块
   • 使用设计模式（如策略模式、工厂模式）提升扩展性
   • 避免重复代码（DRY 原则）

💡 建议参考
如需深入了解代码规范的实践案例，可访问 /代码规范/深入实践 查看更多内容。