运行时依赖
无特殊依赖
安装命令
点击复制官方npx clawhub@latest install code-documenter
镜像加速npx clawhub@latest install code-documenter --registry https://cn.longxiaskill.com
技能文档
简介
代码文档生成器(Code Documenter)是一款用于自动生成代码文档的工具,支持多种文档格式和规范。用法
- 添加文档字符串:直接在代码中使用工具生成文档字符串。
- 创建 API 文档:一键生成基于 OpenAPI/Swagger 或 JSDoc 的 API 文档。
- 构建文档网站:使用工具构建完整的文档门户和教程网站。
示例
# 示例命令(假设)
$ code-documenter generate --type openapi --output ./docs