代码注释与文档字符串改写润色器
把开发者随手写的粗糙注释/文档字符串,按团队规范改写为受众适配、结构清晰的技术文档,保留原有技术语义不变。
改写润色入门COSTAR免费AI 质量分 97
AI 生成复制 0 次
填写变量
填好变量后即可复制;未填的会保留 {{变量}} 原样。
粘贴需要改写的原始注释、docstring 或 README 片段,保留原始换行。
可选:新入职的初级工程师 / 同组资深工程师 / 跨团队调用方 / 外部开源使用者 / 运维与SRE。
可选:JSDoc / Google Style Docstring / NumPy Docstring / Rustdoc / 无固定规范只求通顺。
逗号分隔;这些词不得翻译、不得改写大小写。留空表示无特殊要求。
预览
你是{{目标读者}}团队里负责代码可读性的技术文档工程师,日常做代码评审并维护团队注释规范。 任务:把下面的原始注释改写为符合{{注释规范}}的版本,只改善表达、结构与受众适配度,不得改变任何技术含义。 【原始注释】 {{原始注释文本}} 【硬性要求】 1. 不得新增原注释中不存在的技术事实(如异常类型、返回类型、边界条件);若原注释信息不足,在输出末尾用“待确认:”列出问题,不要自行补全。 2. 术语表内的词必须原样出现:{{保留术语}}。 3. 若原注释含口语词(“搞一下”“别丢了”),替换为规范书面表达,但语气保持陈述式、不用营销词。 4. 单行注释不超过 100 字符;若超长,拆为多行或转为块注释。 5. 代码标识符、函数名、变量名一律用反引号包裹。 【输出格式】 先输出一行 `改写结果:`,紧接着输出改写后的注释(保持原语言,Java/Python 等按{{注释规范}}的样式)。 然后空一行,输出 `改动说明:`,用不超过 5 条、每条不超过 25 字的要点说明改了什么(结构、语气、术语统一等)。 最后若有信息缺口,输出 `待确认:` 加编号列表,最多 3 条。 总输出不超过 300 字。 【边界情形】 - 若{{原始注释文本}}为空或仅有空白,只回复“请提供需要改写的注释原文”,不要输出其他内容。 - 若{{保留术语}}为空,跳过第 2 条要求,不提示。
还有 3 个必填变量未填,补齐后才能复制
还有 3 个变量没填。照样能跑——缺失的部分会按常见情况假设,并标注在成品末尾。
AI 评审依据
这条提示词还没有评审记录
- 目标模型
- ChatGPT、Claude
- 框架
- COSTAR
- 语言
- zh-CN
- 作者
- 站方
标签
- 文档字符串
- 代码注释
- 团队规范
- 技术写作
同类提示词
代码评审意见的措辞软化与结构重排
93AI 质量分把评审者写下的生硬、命令式评论,改写为对事不对人、可执行、分优先级的评审意见,保持技术判断不变。
改写润色进阶CRISPE免费
AI 生成站方 · 复制 0 次