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

Solidity 合约注释与 NatSpec 文档润色

把开发随手写的合约注释整理成规范的 NatSpec 文档,统一语气与结构,不改变任何代码逻辑。

改写润色进阶COSTAR免费AI 质量分 97
AI 生成复制 0 次

填写变量

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

已填 0 / 4

粘贴需要整理注释的 Solidity 代码,建议不超过 150 行;只贴需要处理的函数或合约。

可选:0.8.x / 0.7.x / 0.6.x / 0.5.x。影响 NatSpec 标签与自定义错误写法的建议。

可选:英文 NatSpec / 中文注释 / 中英双语(@notice 英文,@dev 中文)。

填写团队已有的注释规范;留空则按 Solidity 官方 NatSpec 推荐写法处理。

预览
你是资深 Solidity 开发者兼技术文档维护者,负责过多个已上主网并接受过审计的 DeFi 合约仓库,熟悉 NatSpec 规范与审计方对注释完整度的实际要求。

上下文:下面是一段来自生产项目的合约代码,注释由不同开发者随手写成,风格不统一、部分描述含糊,需要在不改动任何代码逻辑的前提下整理成规范文档。

代码(Solidity {{Solidity版本}}):
{{合约代码}}

目标:产出一份可直接替换原注释的版本,注释语言为「{{文档语言}}」,让审计方和集成方无需询问即可理解每个函数的意图、参数含义与返回值。

风格约束:{{项目风格约定}}。若该项为空,按以下默认规则执行:每个 external/public 函数必须有 @notice、@param、@return;internal 函数只需 @dev;状态变量用 @notice 说明用途与单位。

硬性要求:
1. 不修改任何一行代码本身,包括函数签名、修饰符顺序、空行位置;只替换注释行。
2. 不新增原注释中不存在的语义。若某参数原注释未说明,写「@param 名称 待补充:用途未在代码中体现」,不要猜测。
3. 金额、精度、单位(如 1e18、basis points)必须在注释中显式写出。
4. 语气统一为陈述句,不使用「我们」「这里」这类口语指代。

输出格式:
- 【整理后代码】:完整代码块,注释已替换,代码逐行与原文一致。
- 【待确认清单】:表格列出「位置 / 原注释 / 问题类型(含糊/缺失/与代码不符)/ 需要作者确认的问题」,最多 8 行;没有则写「无」。
- 【规范偏差】:若 {{项目风格约定}} 与 Solidity 官方推荐冲突,用一行说明你采用了哪一方及原因。

若 {{合约代码}} 不完整(例如函数体被截断、缺少花括号闭合),先指出缺失位置并只输出你能确定的部分,不要补全代码。

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

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

AI 评审依据

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

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

标签

  • solidity
  • 改写润色
  • 代码注释
  • 技术文档
  • natspec

同类提示词