Standardoc：连接代码与文档的跨语言开源工具链

一个语言无关的开源文档工具，旨在弥合代码与文档之间的鸿沟，同时服务于人类开发者和LLM智能体的工作流。

在软件开发中，文档与代码的脱节是一个长期存在的痛点。代码在不断演进，而文档往往滞后甚至过时；开发者需要同时维护两份内容，增加了认知负担。

随着大语言模型（LLM）在编程辅助领域的普及，这个问题变得更加复杂——LLM需要理解代码库的结构和意图，而传统的文档格式往往无法提供机器友好的语义信息。

Standardoc 项目正是为了解决这一双重挑战而生。它提出了一种统一的文档范式，既方便人类阅读，又能为AI智能体提供结构化的上下文信息。

与Javadoc、Sphinx等语言特定的文档工具不同，Standardoc 采用语言无关的设计。无论你使用 Python、Go、Rust 还是 JavaScript，都可以使用同一套工具链生成一致的文档。这种统一性对于多语言项目（polyglot codebase）尤其有价值。

Standardoc 不仅是从代码生成文档，更强调双向连接：

• 代码到文档：自动提取代码结构、类型信息、注释生成文档
• 文档到代码：文档中的示例代码可以自动验证，确保与实现同步
• 语义关联：建立代码实体与文档章节之间的显式链接

项目原生支持LLM友好的输出格式，包括：

• 结构化的JSON/JSONL表示，便于模型解析
• 保留代码的语义层级（模块、类、函数、参数）
• 嵌入代码的依赖关系图和调用链

Standardoc 使用统一的抽象语法树（AST）表示不同语言的代码结构。解析器层负责将各语言的源码转换为这种中间表示，后续处理逻辑与具体语言解耦。

目前已支持或计划支持的语言：

• Python（基于ast模块）
• Go（基于go/ast）
• TypeScript/JavaScript（基于TypeScript编译器API）
• Rust（基于syn）
• Java/Kotlin（基于JavaParser）

引擎接收统一AST，根据配置的模板生成输出。支持的输出格式包括：

• Markdown（适合GitHub、静态站点生成器）
• HTML（带交互式导航）
• JSON（供LLM消费）
• 自定义模板（基于Handlebars/Jinja2）

对于大型代码库，完整重新生成文档可能很慢。Standardoc 实现了增量更新机制，只处理变更的文件和相关依赖，大幅提升迭代效率。