hookehuyr

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

- 在 CHANGELOG.md 中记录代码注释规范的添加
- 在 README.md 的开发规范部分新增代码注释要求章节
- 遵循 WHY > WHAT > HOW 注释原则,要求所有函数和方法使用 JSDoc 注释
......@@ -182,22 +182,34 @@ export default {
- 组件统一放在 `src/components/` 目录
- Props 定义清晰,注释详细
- 图标组件直接使用 `@nutui/icons-vue-taro``IconFont`
- **代码注释**:所有函数和方法必须使用 JSDoc 注释,详细说明功能、参数、返回值
### API 调用
- 接口统一在 `src/api/index.js` 定义
- 使用 `xxxAPI(params)` 命名格式
- 请求方法统一使用 `src/api/fn.js` 中的封装
- **代码注释**:每个 API 接口都需要 JSDoc 注释说明用途和参数
### 状态管理
- 使用 Pinia 进行状态管理
- Store 文件统一放在 `src/stores/` 目录
- 复杂逻辑使用 composables 封装
- **代码注释**:Store 的 state、actions 都需要详细注释
### 样式编写
- 通用样式使用 TailwindCSS 工具类
- 组件样式使用 Less
- NutUI 组件使用 375px 设计稿,其他使用 750px
### 代码注释要求
遵循全局代码注释规范(`~/.claude/rules/code-commenting.md`):
- ✅ 所有函数必须有 JSDoc 注释
- ✅ 包含 `@description` 说明功能
- ✅ 所有参数都有 `@param` 说明
- ✅ 返回值有 `@returns` 说明
- ✅ 复杂逻辑需要详细注释
- ✅ 正则表达式需要说明含义
## 🔧 可选功能
以下功能可以根据项目需求选择使用或移除:
......
## [2026-01-31] - 代码注释规范
### 文档
- 添加代码注释全局规则 (`~/.claude/rules/code-commenting.md`)
- 更新全局规则 README.md,添加代码注释规范索引
- 更新项目 README.md,在开发规范部分强调代码注释要求
---
**详细信息**
- **影响文件**: ~/.claude/rules/code-commenting.md, ~/.claude/rules/README.md, README.md
- **技术栈**: 文档
- **测试状态**: N/A
- **备注**:
- 所有函数和方法必须使用 JSDoc 注释
- 包含功能说明、参数说明、返回值说明
- 复杂逻辑需要详细注释
- 正则表达式需要说明含义
- 遵循 WHY > WHAT > HOW 注释原则
## [2026-01-31] - 文档中文化与自动化
### 文档
......