💻 开发规范指南

代码规范

✅ 命名规范

• 变量名使用 snake_case（如：user_name）
• 函数名使用 camelCase（如：calculateTotalPrice）
• 常量名全大写（如：MAX_RETRY_COUNT）

💡 格式标准

• 缩进使用 4 个空格
• 每行不超过 80 字符
• 注释需用中文说明逻辑（如：// 初始化请求参数）

项目结构

📁 项目应遵循以下目录布局：

1. src/ - 源代码目录
2. docs/ - 技术文档目录
3. tests/ - 单元测试目录
4. .gitignore - 版本控制忽略文件

🔗 点击查看完整项目结构示例

文档标准

📝 文档需包含：

• 功能说明（使用 📘 Emoji 标记）
• API 接口文档（推荐使用 Swagger）
• 依赖项清单（如：npm install 或 pip install）
• 版本更新记录（用 📅 Emoji 标记）

扩展阅读

想要深入了解开发规范？
👉 点击这里查看最佳实践指南