YARD 是一个 Ruby 文档工具。Y 代表"Yay!"
YARD 是一个用于 Ruby 编程语言的文档生成工具。 使用户能够生成一致、可用的文档,这些文档可以 非常容易导出到多种格式,还支持扩展 自定义 Ruby 构造,例如自定义类级别定义。下面是一个示例: 一些 YARD 显著功能的摘要。
1. 内置 RDoc/Markdown 混合支持: YARD 附带内置标记语言 一个支持 RDoc 和 Markdown 格式化的渲染器,无需额外配置 需要外部 gem。您可以自由地混合 RDoc 样式和 Markdown 样式 无需安装任何附加库即可生成文档。
**2. 与 Python、Java、Objective-C 等语言相同的 Yardoc 元标签格式化：**YARD 使用 '@tag' 样式定义语法来定义元标签，与常规代码文档并列使用。这些标签可以与 RDoc 格式的文档并列使用，但提供了更加一致且易于使用的方式来描述对象的重要信息，例如其接受的参数、预期的类型、方法应该返回的类型、可能引发的异常、是否已过时等。此外，它还允许在输出生成阶段更好地（且更加一致地）组织信息。您可以在 {file:docs/Tags.md#taglist Tags.md} 文件中找到标签列表。
YARD 还支持可选的 "types" 声明,用于特定标签。这允许开发人员以非侵入性但有用且一致的方式记录 ruby 方法和参数的类型签名。而不是在说明体中描述这些数据,开发人员可以在单行中正式声明参数或返回类型。考虑以下使用 YARD 格式化的方法:
暂无开放 Issues，或尚未同步最近议题。