yard

YARD 是一个用于 Ruby 语言的文档生成工具。它支持 RDoc 和 Markdown 格式的混合使用，无需额外安装库即可自由混用这两种格式。YARD 使用类似于 Python、Java 等语言的元标签格式（如 @param, @return），使得开发者可以更一致且详细地描述代码中的重要信息，例如参数类型、返回值、异常等。此外，YARD 还允许为这些标签添加可选的类型声明，进一步增强了文档的一致性和可用性。该工具非常适合需要为 Ruby 项目创建高质量、结构化文档的场景，无论是个人项目还是团队协作开发都能从中受益。