GPT中文www.gpt.com.cn挑几下就能开工
我积分

写接口注释

关于「写接口注释」:能拿到什么、要点选什么、怎么办

点几下接口类型,3 分钟拿到标准接口注释。这工具帮你给接口写注释,不用自己纠结格式。选好接口类型、方法、参数风格,自动生成标准注释,拿来就用。

能拿到什么

  • 推荐:生成接口注释文本,并可整理成 Markdown 或 Word 说明文档(一张纸或一段代码注释,参数、异常、示例分块列出),约 3 分钟
  • 旗舰:接口注释文本、Markdown 接口说明文档、Word 接口文档

要你点选的几项

接口类型、方法类型、参数风格、返回值类型、注释详细度、参数说明、异常说明、示例、接口名称、额外说明、不替代人工,开发者确认。多数点一下就行,没选的按常见情况替你定,交付时说清哪几项是按默认的。

怎么办

  1. 选接口类型和方法
  2. 设参数风格和返回值
  3. 填接口名称和额外说明
  4. 生成注释确认使用

别人还这样说

  • 我这有一堆接口代码,能不能帮我自动生成标准的注释文档?
  • 开发者太懒不想写注释,你帮我把这段代码的说明整理成规范格式。
直接办
直接说你要办的事。下面是别人怎么办的,点任何一项就换成你自己的。左边是别人怎么办的,右边是你的,点一项就开始改。
示范 · 别人这样说

「这个交互的约定要写清楚」

替他选了:标准 · 是 · 是 · 是

按示范选好的 点一项就变成你的

你的成品会在这里出现
示例成品 · 不是你的AI 按示范写的,看个样子
/** * 创建用户 * POST /api/users * 请求体参数: * - name (string): 用户名 * - email (string): 邮箱 * 返回 JSON: * { * "id": number, * "name": string, * "email": string * } * 异常: * - 400 参数验证失败 * - 409 用户已存在 */ public Response createUser(@RequestBody UserRequest request) { ... }

条款 · 隐私