codeium不会默认生成组件文档,必须显式要求;使用三段式提示词模板(极简直给型/分步确认型/对标已有文档型)可确保输出含完整markdown使用文档、props接口定义及可运行示例代码。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你想让Codeium帮你写一个前端组件,但生成的代码缺注释、没说明怎么用、也不清楚props类型和限制条件——这时候不是Codeium不行,而是你给它的指令没把“写文档”这件事当成工程动作来派活。
先明确:Codeium不默认写文档,必须显式要求
Codeium本质是补全与生成工具,它不会主动为组件产出使用说明。如果你只说“写一个带搜索的下拉框”,它大概率只返回JSX+TS类型定义,连一句“如何引入”都不会提。这一步漏掉,后续所有文档都无从谈起。
所以第一步永远是:在需求开头就锁定“输出必须含完整使用文档”。
新手可用的三段式提示词模板
直接复制下面任一模板,把方括号里的内容替换成你的实际需求,就能跑通:
方法一:极简直给型(适合赶时间、功能明确)
请帮我用 React + TypeScript 实现一个【可多选的树形选择器】组件,要求:
• 支持受控模式(value / onChange)
• 支持异步加载子节点
• 输出必须包含:
– 完整组件代码(含Props接口定义)
– 【一份独立的 Markdown 格式使用文档】,含:安装方式、基本用法、Props 表(字段名/类型/是否必填/说明)、示例代码(带注释)、常见问题(如“如何禁用某节点”)
方法二:分步确认型(适合怕出错、要全程把控)
我要开发【带权限校验的按钮组件】。请严格按以下顺序执行:
① 先输出该组件的 Props 接口定义(TS),并标注每个字段是否必填、用途、可选值(如 status: 'primary' | 'danger')
② 再输出组件主体代码(React 函数组件,含权限判断逻辑)
③ 最后输出一份独立的使用文档(Markdown 格式),必须包含:
– 引入路径示例(如 import { AuthButton } from '@/components/ui')
– 三个递进式使用示例(基础用法 → 带 loading → 权限拒绝时的 fallback 文案)
– 注意事项(如“不支持 onClick 阻止冒泡,请用 onAuthFail 替代”)
每完成一步,请等待我回复“继续”再执行下一步。
方法三:对标已有文档型(适合团队有规范、要风格统一)
请参考我们项目中 Button 组件的 README.md(结构含:简介、安装、API 表、示例、注意事项),为【文件上传拖拽区组件】生成同等质量的使用文档(Markdown)。同时提供该组件的完整实现代码(React + TS),确保文档中提到的所有 Props、示例、限制条件,在代码里都有对应实现和类型约束。文档开头需注明:“本文档与 src/components/DragUpload/index.tsx 严格同步,最后更新于 2026-05-29”。
关键避坑点:新手最容易漏的3个文档要素
很多新手让Codeium“写文档”,结果拿到的只是几行注释。真正可用的组件文档必须包含这三项,缺一不可:
• 【明确的引入路径】:不能只写“import Component from 'xxx'”,而要写成“import { UploadArea } from '@/components/form'”或“import UploadArea from '@project/ui/src/upload-area'”——路径错,开发者第一秒就卡住。
• Props 表必须带“是否必填”列:只写 type: string 不够,得写“value(string,必填)→ 当前选中的文件 ID 数组”。
• 示例代码必须可直拷直跑:不能出现 placeholderText={t('common.upload')} 这种需要额外 i18n 上下文的写法,应替换为字面量 "点击上传文件" 或加注释说明依赖。











