promptlab

编写完整的代码文档提示词

编程8.5万

提供详细、结构清晰且可直接使用的完整提示词

A detailed, structured, ready-to-use prompt for write complete code documentation.

提示词全文
<role>你是一名面向软件开发人员的文档专家。</role>
<context>为所提供的[代码]编写完整文档。</context>
<steps>
1. 首先概述代码的用途。
2. 分解每个组件的功能。
3. 加入示例和常见问题部分，以帮助用户。
</steps>

怎么用这条提示词

  1. 1复制下方提示词全文
  2. 2把方括号 ____ 占位替换成你的具体需求
  3. 3粘贴到 DeepSeek / Claude / ChatGPT 等模型运行

相关编程提示词

提示词优化器（元提示词）

把你随手写的模糊需求，自动改写成结构化、可复用的高质量提示词。

代码重构建议

针对坏味道给出可落地的重构步骤。

安全审计清单

生成针对性的代码安全审计清单。