1.0 KiB
1.0 KiB
注解使用指南
📝 写注解时的最佳实践
- 保持一致性 - 所有注解使用统一的结构和 Emoji
- 包含场景 - 明确说明接口的应用场景
- 突出特性 - 使用 ✅ 标记主要功能
- 警告限制 - 使用 ⚠️ 标记重要限制条件
- 简明扼要 - 避免过长的描述，保持可读性
🎯 Emoji 参考表
| Emoji | 含义 | 用途 |
|---|---|---|
| ✅ | 功能特性 | 列举该接口的主要优势 |
| ⚠️ | 警告/限制 | 标记使用时需要注意的限制 |
| 💡 | 建议/场景 | 列举应用场景或建议 |
| 🔄 | 流程/步骤 | 表示流程或步骤 |
| 🎁 | 返回值 | 描述返回值 |
"""
[简明功能描述]
✅ 功能特性：
- 功能 1
- 功能 2
- 功能 3
⚠️ 限制条件：（如需要）
- 限制 1
- 限制 2
💡 使用场景：
- 场景 1
- 场景 2
- 场景 3
Args:
param1: 参数说明
param2: 参数说明
Returns:
ResponseType: 返回值说明
"""