hookehuyr

docs: 添加代码注释规范到项目文档

- 在 CHANGELOG.md 中记录代码注释规范的添加
- 在 README.md 的开发规范部分新增代码注释要求章节
- 遵循 WHY > WHAT > HOW 注释原则,要求所有函数和方法使用 JSDoc 注释
...@@ -182,22 +182,34 @@ export default { ...@@ -182,22 +182,34 @@ export default {
182 - 组件统一放在 `src/components/` 目录 182 - 组件统一放在 `src/components/` 目录
183 - Props 定义清晰,注释详细 183 - Props 定义清晰,注释详细
184 - 图标组件直接使用 `@nutui/icons-vue-taro``IconFont` 184 - 图标组件直接使用 `@nutui/icons-vue-taro``IconFont`
185 +- **代码注释**:所有函数和方法必须使用 JSDoc 注释,详细说明功能、参数、返回值
185 186
186 ### API 调用 187 ### API 调用
187 - 接口统一在 `src/api/index.js` 定义 188 - 接口统一在 `src/api/index.js` 定义
188 - 使用 `xxxAPI(params)` 命名格式 189 - 使用 `xxxAPI(params)` 命名格式
189 - 请求方法统一使用 `src/api/fn.js` 中的封装 190 - 请求方法统一使用 `src/api/fn.js` 中的封装
191 +- **代码注释**:每个 API 接口都需要 JSDoc 注释说明用途和参数
190 192
191 ### 状态管理 193 ### 状态管理
192 - 使用 Pinia 进行状态管理 194 - 使用 Pinia 进行状态管理
193 - Store 文件统一放在 `src/stores/` 目录 195 - Store 文件统一放在 `src/stores/` 目录
194 - 复杂逻辑使用 composables 封装 196 - 复杂逻辑使用 composables 封装
197 +- **代码注释**:Store 的 state、actions 都需要详细注释
195 198
196 ### 样式编写 199 ### 样式编写
197 - 通用样式使用 TailwindCSS 工具类 200 - 通用样式使用 TailwindCSS 工具类
198 - 组件样式使用 Less 201 - 组件样式使用 Less
199 - NutUI 组件使用 375px 设计稿,其他使用 750px 202 - NutUI 组件使用 375px 设计稿,其他使用 750px
200 203
204 +### 代码注释要求
205 +遵循全局代码注释规范(`~/.claude/rules/code-commenting.md`):
206 +- ✅ 所有函数必须有 JSDoc 注释
207 +- ✅ 包含 `@description` 说明功能
208 +- ✅ 所有参数都有 `@param` 说明
209 +- ✅ 返回值有 `@returns` 说明
210 +- ✅ 复杂逻辑需要详细注释
211 +- ✅ 正则表达式需要说明含义
212 +
201 ## 🔧 可选功能 213 ## 🔧 可选功能
202 214
203 以下功能可以根据项目需求选择使用或移除: 215 以下功能可以根据项目需求选择使用或移除:
......
1 +## [2026-01-31] - 代码注释规范
2 +
3 +### 文档
4 +- 添加代码注释全局规则 (`~/.claude/rules/code-commenting.md`)
5 +- 更新全局规则 README.md,添加代码注释规范索引
6 +- 更新项目 README.md,在开发规范部分强调代码注释要求
7 +
8 +---
9 +
10 +**详细信息**
11 +- **影响文件**: ~/.claude/rules/code-commenting.md, ~/.claude/rules/README.md, README.md
12 +- **技术栈**: 文档
13 +- **测试状态**: N/A
14 +- **备注**:
15 + - 所有函数和方法必须使用 JSDoc 注释
16 + - 包含功能说明、参数说明、返回值说明
17 + - 复杂逻辑需要详细注释
18 + - 正则表达式需要说明含义
19 + - 遵循 WHY > WHAT > HOW 注释原则
20 +
1 ## [2026-01-31] - 文档中文化与自动化 21 ## [2026-01-31] - 文档中文化与自动化
2 22
3 ### 文档 23 ### 文档
......