GJavaDoc (IntelliJ Plugin)
G for Garbage——把难啃的“垃圾”式遗留代码清运为可读文档。

GJavaDoc 是一款在 IntelliJ IDEA 中运行的“接口文档生成器”。它基于注解扫描入口方法,结合代码切片和本地 LLM,自动生成 Markdown 说明文档,并支持类级文档、上下文打包、并发执行与失败重试等能力。

核心特点

注解扫描:按设置的注解扫描 Java 入口方法(支持多个注解,逗号分隔;默认 @RpcService
增量生成:再次点击 Scan 时,仅为缺失的文档入队(以 docs/ 文件名为准)
模块选择:在工具窗选择单个 Module 或 ALL 扫描
类/方法两种粒度:可按类汇总生成,或按具体方法签名生成
并发与限速:最大并发、RPS 节流、重试与退避
上下文打包:可选收集方法源码、切片、关联类型、被调方法片段等(保存到 context-bundles/)
结果输出:Markdown 到 docs/,可选 JSON 到 method-docs/
可选分目录:勾选“Group docs by module”后输出为 docs/<module>/...
工具窗操作:过滤/分页/重试/取消/重排队/从列表恢复等


https://github.com/GeekyWizKid/GJavaDoc

#java #doc GitHub - GeekyWizKid/GJavaDoc: G for Garbage:把难啃的遗留代码“清运”为文档。注解扫描、切片分析、LLM 生成,支持增量/并发/重试
 
 
Back to Top