promptlab

Write Complete Code Documentation prompt

Coding85K

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

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

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

How to use this prompt

  1. 1Copy the full prompt below
  2. 2Replace the [____] placeholders with your specifics
  3. 3Paste into DeepSeek / Claude / ChatGPT to run

Related Coding prompts

Prompt optimizer (meta-prompt)

Rewrites your rough request into a structured, reusable, high-quality prompt.

Refactoring Advisor

Turn code smells into actionable refactoring steps.

Security Audit Checklist

Generate a targeted code security audit checklist.