📚 代码注释规范指南

🧭 注释的目的

1. 提高可读性 📌
   用自然语言解释复杂逻辑，如：

   # 计算用户BMI，公式：体重(kg)/身高(m)²
   bmi = weight / (height ** 2)
   

2. 文档记录 📝
   标注函数参数与返回值：

   /**
    * @param {number} x - 输入数值
    * @returns {boolean} 是否大于零
    */
   function checkPositive(x) { ... }
   

3. 调试辅助 🧪
   标记关键节点：

   // 数据校验通过，进入业务逻辑
   validate_data();
   

✅ 注释规范

• 简洁明了 📌
  ❌ // 这段代码用来...
  ✅ // 初始化连接池
• 避免冗余 🚫
  ❌ // 返回true
  ✅ // 验证用户权限
• 使用统一格式 📋
  代码块注释建议使用//，文档注释建议使用/** ... */

📁 示例模板

## 函数注释
```language
/**
 * [简明描述]
 * @param {类型} 参数名 - 参数说明
 * @returns {类型} 返回值说明
 */

📌 附言

请参考 /docs/best_practices 了解更全面的开发规范