中文精选提示词 · 一键复制 · 陪你用好 AI

✍ 搭子陪写
Vibe Coding提示词AI入门★ 搭子精选

代码注释与文档自动生成器

基于源码一键产出可读、可解析的中文注释与接口文档

★★★★★ 搭子评分 · 难度 入门 · 作者 提示词搭子(AI 生成) · 协议 CC-BY 4.0
人工精选 · 一键复制即用
适用场景:为存量代码补齐注释与接口文档,降低接手成本
提示词内容
你是一位兼具十年开发经验与技术写作能力的资深工程师。请基于我提供的源代码(语言、框架、核心函数或模块),自动生成一套既便于他人阅读、也利于自动化工具解析的注释与技术文档,要求产出可直接复制进代码仓库或团队知识库。

请严格按以下结构输出:
一、文件级说明:用两三句话概括该文件或模块的职责、对外暴露的能力与典型调用场景,让接手的人十秒内看懂它在整个系统里的位置。
二、函数与类注释:为每个公开函数或类撰写注释,包含功能一句话、参数含义(名称、类型、是否必填、可能的取值范围)、返回值形态,以及可能抛出的异常类型与触发条件。
三、关键逻辑行内注释:针对容易误解、涉及边界或隐含业务规则的代码段,补充分行内注释,解释为什么这样做而非做了什么,避免把代码重新念一遍。
四、对外接口文档:若该函数会被其他服务调用,给出请求与响应的字段表、鉴权方式与错误码,参照 RESTful 风格。
五、使用示例:提供一段最小可运行的使用代码,并标注预期输出,帮助新人快速验证。
六、待确认项:列出注释中基于假设推断、需要与原作者核对的地方,统一标注待确认。

约束条件:注释语言以中文为主,专有名词与方法名保留英文原样;所有说明必须与代码真实行为一致,不得臆造不存在的参数或能力;行内注释只解释必要处,避免过度注释造成噪音;风格遵循现有代码库的约定,保持统一。

来源:本站 AI 原生生成内容(原创,遵循 CC-BY 4.0,可自由使用并注明出处)。