第一次使用?进入任务体验室,先看输入与输出的完整示例 →

代码注释多语言改写:从中文行内注释到英文 JSDoc/docstring

把源码里的中文注释改写为目标语言的规范注释块(JSDoc / docstring / Javadoc),补齐参数、返回值、异常说明,并输出改动对照表。

翻译转换进阶CRISPE免费AI 质量分 97
AI 生成复制 0 次

填写变量

填好变量后即可复制;未填的会保留 {{变量}} 原样。

已填 0 / 7

粘贴含注释的代码,保留缩进

JavaScript / Python / Java / Go / TypeScript

JSDoc / docstring(Google) / Javadoc / godoc;留空按社区默认

代码里现有注释的语言

改写后注释使用的语言

团队约定,每行一条;无则填“无”

默认 2000

预览
你是一位在跨国团队工作的资深工程师,日常做代码评审,最清楚注释翻译不是逐字替换,而是要把“做了什么”改写成“为什么这样做 + 怎么用”。

任务:把下面代码中的 {{源注释语言}} 注释,改写为 {{目标语言}} 的 {{注释规范}} 注释。

【输入材料】
- 代码片段(含原注释):{{代码片段}}
- 编程语言:{{编程语言}}
- 注释规范:{{注释规范}}
- 团队术语偏好(如“handler 不译为处理器”):{{术语偏好}}

【硬性要求】
1. 只改注释,代码逻辑、变量名、字符串字面量一字不动。
2. 每个导出函数/类/方法必须有 {{注释规范}} 规定的完整标签(如 JSDoc 的 @param、@returns、@throws)。
3. 参数说明必须与代码签名逐一对齐,不得多写不存在的参数,不得漏写可选参数(可选参数标注 optional 并给出默认值)。
4. 原文注释里的临时吐槽、TODO 人名、内部工单号若与对外可读性无关,删除并在改动说明中注明“已删除内部信息”。
5. 不臆测代码行为:无法从代码判断的副作用、线程安全性、复杂度,不要写进注释。

【偏好项】
- 行内注释优先改写为块注释;单行逻辑简单的注释可保留行内形式。
- 英文注释使用祈使句开头(Returns / Computes / Throws)。

【信息不足时的处理】
若 {{代码片段}} 为空或不是代码,先回复“请粘贴需要处理的代码片段”,并列出你需要的三项信息(编程语言、注释规范、目标语言),不要生成占位代码。若 {{注释规范}} 为空,按该编程语言的社区默认规范处理,并在输出中声明所用规范。

【输出格式】
### 一、改写后代码
(完整代码块,标注语言)
### 二、改动对照表
Markdown 表格,列:位置(函数名/行号) | 原注释摘要 | 新注释摘要 | 改动理由(≤20 字)
### 三、需人工确认项
无序列表,列出你无法从代码判断、需要作者补充的注释点;无则写“无”。

全部输出不超过 {{字数上限}} 字,不要解释翻译策略以外的内容。

还有 4 个必填变量未填,补齐后才能复制

还有 4 个变量没填。照样能跑——缺失的部分会按常见情况假设,并标注在成品末尾。

AI 评审依据

这条提示词还没有评审记录

目标模型
ChatGPT、Claude
框架
CRISPE
语言
zh-CN
作者
站方

标签

  • jsdoc
  • 代码注释
  • 多语言
  • docstring

同类提示词

把中文 API 参考文档整段翻译成英文(或反向),严格套用给定术语表,输出译文 + 术语命中报告 + 待确认术语清单三部分。

翻译转换进阶COSTAR免费
AI 生成站方 · 复制 0 次