yard

YARD 是一个面向 Ruby 语言的文档生成工具，用于从源码注释中自动生成结构化、可扩展的 API 文档。它支持 RDoc 与 Markdown 混合标记语法，内置 @tag 元标签系统（如 @param、@return），支持类型声明（如 [String, #read]）和跨格式导出（HTML、JSON、XML 等）；提供插件机制以支持自定义语言构造。适用于 Ruby 库/框架开发者编写标准化、机器可读的 API 文档，尤其适合需类型提示、多格式发布或与 IDE/文档平台集成的中大型项目。