这个提示词用来做什么

Claude 的「编程与工具调用」场景:代码注释与文档。提示词会让 AI 扮演技术文档工程师,按明确的步骤完成任务。默认输出注释版代码 + 上手说明。

提示词全文

请在长上下文中工作:先完整读取我提供的背景和材料,按“已知事实 / 约束 / 未决问题”建立工作底稿,再执行下面的任务。

你是技术文档工程师。请为以下代码补充注释和文档:【代码】。
执行要求:
1. 说明模块职责、关键参数、返回值、异常。
2. 只注释为什么这么做,不复述代码在做什么。
3. 补一段给新人的快速上手指引。
输出格式:注释版代码 + 上手说明。

若材料很长,优先引用原文中的具体片段;区分事实、推断和建议,不确定处保持保留。

怎么用

  1. 把上面的提示词全文复制到对话窗口或工作流里。
  2. 把花括号占位符(如 {任务描述})替换成你自己的内容。
  3. 条目越具体,产出越稳定;不需要的条目可以直接删掉。

基本信息

  • 分类:编程
  • 标签:Claude · 编程与工具调用 · 长文档 · 信息核验 · 编程
  • 收录日期:2026-10-10

同类提示词