| New file |
| | |
|---|
| | | # 更新公共组件文档 |
|---|
| | | |
|---|
| | | ## 第一步，检查组件 |
|---|
| | | |
|---|
| | | ### 根据组件路径，检查是否为公共组件 |
|---|
| | | |
|---|
| | | 检查当前组件路径，如果不在公共组件目录内，则不是公共组件，不适用本更新策略，任务跳过 |
|---|
| | | |
|---|
| | | 公共组件的三个目录： |
|---|
| | | - src/components/forms |
|---|
| | | - src/components/layout |
|---|
| | | - src/components/plugins |
|---|
| | | |
|---|
| | | ### 读取组件，检查是否为 Vue 组件 |
|---|
| | | |
|---|
| | | 根据组件内容，判断为是不是 Vue 组件，如果不是，任务跳过 |
|---|
| | | |
|---|
| | | ## 第二步，检查文档是否已经存在 |
|---|
| | | |
|---|
| | | 每一个公共组件，都有一份组件文档 |
|---|
| | | |
|---|
| | | 如果当前组件为： |
|---|
| | | src/components/forms/checkbox/CCheckBox.vue |
|---|
| | | |
|---|
| | | 那么它对应的文档为： |
|---|
| | | src/components/_cursor.ai/forms.doc/checkbox.doc/CCheckBox.doc.md |
|---|
| | | |
|---|
| | | 其规律为： |
|---|
| | | - 组件的文档都在 src/components/_cursor.ai/ 文件夹下，有类似的目录结构 |
|---|
| | | - 组件文件夹 forms/ 对应文档文件夹 forms.doc/（名称增加 `.doc`） |
|---|
| | | - 组件子文件夹 checkbox/ 对应文档子文件夹 checkbox.doc/（名称增加 `.doc`） |
|---|
| | | - 组件文件 CCheckBox.vue 对应文档文件 CCheckBox.doc.md（名称增加 `.doc`，但扩展名不变） |
|---|
| | | |
|---|
| | | ## 第三步，如果文档不存在，创建 |
|---|
| | | |
|---|
| | | 依照位置与命名规律，按照文档格式创建对应的组件文档 |
|---|
| | | |
|---|
| | | ## 第四步，如果文档已存在，更新文档 |
|---|
| | | |
|---|
| | | 读取文档内容，将组件功能与文档对比 |
|---|
| | | - 判断文档是否符合文档格式的要求，如果不符合，请按格式修改 |
|---|
| | | - 判断是否需要修剪已有内容和增加新内容，如果有，更新文档 |
|---|
| | | |
|---|
| | | ## 文档格式 |
|---|
| | | |
|---|
| | | 文档格式为markdown，每份组件需要包含一下项目： |
|---|
| | | - 由组件文件名+组件中文名组成大标题 |
|---|
| | | - 功能说明 |
|---|
| | | - 引用方式 |
|---|
| | | - 组件参数 |
|---|
| | | - 请使用列表形式，例如：- `paramName` (String，可选)：参数说明 |
|---|
| | | - 如果是可枚举的几个具体值，请以二级列表的形式说明每个值，例如：- `enumValue`：枚举值说明 |
|---|
| | | - 如果是回调函数，请以二级列表的形式说明函数的参数和返回值，例如：- 参数 `paramName` (String，可选)：参数说明 |
|---|
| | | - 实例方法 |
|---|
| | | - 是指 methods 中，名称仅以 `$` 符号开头的方法，没有 `$` 可省略 |
|---|
| | | - 如果方法有参数，请以二级列表形式说明方法的参数和返回值，例如：- 参数 `paramName` (String，可选)：参数说明 |
|---|
| | | - 使用示例 |
|---|
| | | - 如果组件有多种使用模式，请分别提供不同模式的示例 |
|---|
| | | - 注意事项 |
|---|
| | | - 重要或需要注意的问题 |
|---|
| | | - 特殊的技术点或使用场景 |
|---|
