项目-A 代码规范

📌 本规范旨在统一项目-A 开发中的代码风格，提升可读性与维护性

一、命名规范

• 变量名使用 snake_case，如 user_name
• 函数名使用 camelCase，如 calculateTotalPrice
• 常量名全大写，如 MAX_RETRY_COUNT
• 类名使用 PascalCase，如 OrderProcessor

二、格式规范

• 缩进使用 4 个空格
• 每行不超过 80 字符
• 控制台输出添加 DEBUG_ 前缀，如 DEBUG_请求处理中
• 异常处理需包含具体错误码，如 try...catch (err) { console.error('ERR_001', err) }

三、注释规范

• 函数注释需包含参数说明与返回值
• 关键逻辑添加行内注释，如 // 避免空指针异常
• 版本变更需记录变更日志

四、扩展阅读

点击查看项目-A 文档首页 了解更多开发规范
参考 GitHub 代码风格指南 深入理解最佳实践

编码标准