SuperAPI AI 工具集

code-documentation-generator

写作与研究

查看项目

更新于 10-15 21:08

技能介绍

用途:为代码编写与自动生成高质量文档,覆盖 JavaScript/TypeScript 的 JSDoc、Python docstring(Google 与 NumPy 风格)、REST API 文档、README 和内联注释。

主要能力:提供各语言的注释模板与示例;支持 JSDoc 标签(@param、@returns、@throws、@example);Python 的 Args/Returns/Raises 与 Parameters/Returns 段落;可生成 OpenAPI/Swagger 风格接口定义和 Markdown API 文档;附带 README 模板(功能、快速开始、安装、配置、贡献、许可证)以及内联注释规范(解释原因而非复述代码、说明复杂逻辑与业务规则)。

自动生成:TypeScript 可用 TypeDoc,配置 typedocOptions(entryPoints、out、plugin、excludePrivate 等);Python 可用 Sphinx,启用 autodoc、napoleon、viewcode、sphinx_autodoc_typehints,并配置 autodoc_default_options。

最佳实践:记录公开 API;示例使用真实用例;文档随 PR 同步更新;用 eslint-plugin-jsdoc、pydocstyle 等 linter 校验;按代码版本管理文档。

限制:资料未提供具体安装命令、价格、平台或量化效果;部分配置片段为示例,需按项目实际情况调整。