搜索你想找的开源项目

输入名称、用途或关键词,也可粘贴 GitHub 仓库链接
全部技能

code-documenter

为代码补充 docstring、JSDoc 或 OpenAPI 规范,并验证示例可运行。

适合什么时候用

你已有可运行的代码,但缺少行内文档或 API 规范,需要在分享前补上 docstring 或 OpenAPI 文件。

举个例子

你对 AI 说

用 code-documenter 给我的 Python FastAPI 项目中的公共函数添加 Google 风格 docstring,并为接口生成 OpenAPI 规范。

你会拿到
  • 带文档的 Python 文件
  • OpenAPI 规范
  • 覆盖率报告

它会怎么做

  • 动笔前先询问你偏好的 docstring 格式。
  • 用 doctest、tsc 或 Redocly lint 验证示例可编译后再出报告。