🔧 代码结构
- 模块划分应遵循单一职责原则，每个文件只负责一个功能点
- 使用清晰的函数/方法命名，避免模糊缩写（如
calc应改为calculateTotal） - 控制代码嵌套深度不超过3层，复杂逻辑需拆分为独立函数
📝 注释规范
- 关键逻辑需添加注释，注释应说明「为什么」而非「是什么」
- 使用统一注释格式（如
// TODO:或# FIXME:） - 示例：
# 需要优化：该循环存在性能瓶颈，建议使用生成器提升效率 for i in range(1000000): process_data(i)
🛡️ 安全规范
- 用户输入必须进行校验与过滤，防止注入攻击
- 敏感信息（如密码）需使用加密存储，避免明文传输
- 示例代码需包含安全校验逻辑：
// 验证邮箱格式 const isValidEmail = (email) => /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(email);
📦 版本控制
- 每次提交需附带明确的提交信息（如
feat: 实现用户认证模块） - 使用语义化版本号（SemVer），主版本号用于重大更新
- 代码分支命名需符合规范（如
feature/new-login）