AI 使用说明
只写一句“DHdesign 基于 Element Plus 和 Vant 实现”,只能让 AI 猜到大方向,不能让它稳定写对代码。
AI 还需要知道这些信息:
- 应该从
@szhn/dh-design-mobile或@szhn/dh-design-pc导入组件。 - 移动端模板里使用
van-前缀组件名,PC 端使用el-前缀。 - 哪些组件只是透传上游能力,哪些组件有 DHdesign 自己新增的能力。
- 主题色应该通过 DHdesign 的主题方法设置,而不是直接改 Vant 或 Element Plus 变量。
- 每个组件的 Props、Events、Slots、示例和注意事项。
推荐做法
给 AI 提供这些材料,比单独写一句说明更可靠:
- 当前文档站。
- 包内 README。
- TypeScript 类型声明。
- 组件示例代码。
llms.txt这类专门给 AI 读取的入口文件。
给 AI 的提示词
在公司内部 AI 或代码助手里,可以先给它这样的提示:
txt
你正在使用 DHdesign 组件库。
移动端组件从 @szhn/dh-design-mobile 导入,基于 Vant 4 实现。
PC 端组件从 @szhn/dh-design-pc 导入,基于 Element Plus 2 实现。
模板中使用 van-/el- 前缀组件标签。
如果 DHdesign 文档没有特别说明,Props、Events、Slots 基本沿用对应上游组件。
请优先阅读 DHdesign 文档、README、类型声明和示例,不要直接把 Element Plus 或 Vant 的导入路径写进业务代码。