From 3b03f87a02458f719e2eb4bf112a13441b427d14 Mon Sep 17 00:00:00 2001
From: ‘chensiAb’ <‘chenchenco03@163.com’>
Date: Tue, 25 Mar 2025 13:54:34 +0800
Subject: [PATCH] Merge branch 'master' of ssh://dev.zhiheiot.com:29418/mob-components

---
 _cursor.ai/prompts/更新公共组件文档.prompts.md |   32 +++++++++++++++++++++++---------
 1 files changed, 23 insertions(+), 9 deletions(-)

diff --git "a/_cursor.ai/prompts/\346\233\264\346\226\260\345\205\254\345\205\261\347\273\204\344\273\266\346\226\207\346\241\243.prompts.md" "b/_cursor.ai/prompts/\346\233\264\346\226\260\345\205\254\345\205\261\347\273\204\344\273\266\346\226\207\346\241\243.prompts.md"
index bd62fe2..eed6f00 100644
--- "a/_cursor.ai/prompts/\346\233\264\346\226\260\345\205\254\345\205\261\347\273\204\344\273\266\346\226\207\346\241\243.prompts.md"
+++ "b/_cursor.ai/prompts/\346\233\264\346\226\260\345\205\254\345\205\261\347\273\204\344\273\266\346\226\207\346\241\243.prompts.md"
@@ -33,15 +33,29 @@
 
 ## 第三步，如果文档不存在，创建
 
-依照位置与命名规律，创建对应的 markdown 文档文件
-
-每份组件文档包含：功能说明、引用方式、组件参数、示例方法、使用示例、注意事项
-- 组件参数请使用列表形式，例如：- `paramName` (String，可选)：参数说明
-- 组件参数如果是可枚举的几个具体值，请以二级列表的形式说明，例如：- `enumValue`：枚举值说明
-- 实例方法是指 methods 中，名称以 `$` 符号开头的方法，没有可省略
-- 提供使用示例时，如果组件有多种使用模式，请分别提供不同模式的示例
-- 如果组件有特殊的技术点或使用场景，请在注意事项中说明
+依照位置与命名规律，按照文档格式创建对应的组件文档
 
 ## 第四步，如果文档已存在，更新文档
 
-读取文档内容，对比组件与文档，判断文档是否需要修剪已有内容和增加新内容，如果有，更新文档
+读取文档内容，将组件功能与文档对比
+- 判断文档是否符合文档格式的要求，如果不符合，请按格式修改
+- 判断是否需要修剪已有内容和增加新内容，如果有，更新文档
+
+## 文档格式
+
+文档格式为markdown，每份组件需要包含一下项目：
+- 由组件文件名+组件中文名组成大标题
+- 功能说明
+- 引用方式
+- 组件参数
+    - 请使用列表形式，例如：- `paramName` (String，可选)：参数说明
+    - 如果是可枚举的几个具体值，请以二级列表的形式说明每个值，例如：- `enumValue`：枚举值说明
+    - 如果是回调函数，请以二级列表的形式说明函数的参数和返回值，例如：- 参数 `paramName` (String，可选)：参数说明
+- 实例方法
+    - 是指 methods 中，名称仅以 `$` 符号开头的方法，没有 `$` 可省略
+    - 如果方法有参数，请以二级列表形式说明方法的参数和返回值，例如：- 参数 `paramName` (String，可选)：参数说明
+- 使用示例
+    - 如果组件有多种使用模式，请分别提供不同模式的示例
+- 注意事项
+    - 重要或需要注意的问题
+    - 特殊的技术点或使用场景
\ No newline at end of file

--
Gitblit v1.9.1