问题标签 [yard]

在YARD 自述文件中，提到了raw data由 YARD 生成：

YARD 还将记录的对象作为原始数据（转储的命名空间）输出，可以重新加载以在以后生成，甚至对代码进行审计。这意味着任何开发人员都可以使用原始数据为任何自定义格式（例如 YAML）执行输出生成。

raw data使用和翻译成其他格式的例子/博客/教程是什么？例如，我有兴趣将部分原始数据转换为 YAML。

如何使用 YARD创建指向 ruby​​ 类方法的链接？这是有关链接的院子文档。

链接到同一命名空间内的实例方法：

哪个工作正常。但是，使用类方法遵循相同的方法不会编译和修改它：

生成以下纯文本（不是链接）：

即使在安装 gem 时，有没有办法完全替换 rdoc？

就像现在一样，gem server只能访问 rdoc 生成的文档。在某些情况下，例如 FFI-gem，文档是用 yard 编写的，试图通过 rdoc 生成的文档来阅读是一件gem server很痛苦的事情。

那么有没有可能用 yard 替换 rdoc

我有一个使用Forwardable模块中的def_delegators方法的类。我还没有找到让Yardoc为其输出文档的方法。我尝试使用宏，但它不会为这些特定方法输出任何内容（文件中的其他所有内容都很好，并且没有错误），而且我有几个不同的长度。def_delegators

例如

如果有人知道宝石或这样做的方法，这意味着我可以避免尝试编写 Yard 扩展来执行此操作，我将非常感激。

为了本地化我的 Gherkin 脚本，我#language:ru在每个 .feature 文件的最顶部添加了注释，并开始为步骤和场景使用本地化名称。

但是，在使用 yard-cucumber 插件记录我的脚本后，此注释在生成的 html 文档中仍然存在（并且它在功能名称下可见）。它还features/category_info.feature:3在每个背景/场景块之后添加行。是调试模式的某种osrt吗？我使用“yardoc -c”命令创建文档，自动加载 yard-cucumber 插件。

我错过了什么吗？我如何让院子里省略这些文物？

我在为以下 DSL 编写 YARD 插件时遇到问题：

现在我想为这些方法的文档片段添加注释，这些片段受 DSL “影响” my_dsl。在my_dsl处理程序中，范围完全不同（我不想添加一些新文档，我想扩展已经存在的方法。）

所以我决定在里面使用Proxy代码对象MyDSLHandler#process来标记延迟未来后处理所需的方法（这将发生在内置MethodHandleron 中def do_it ; … ; end。）它看起来像：

现在的问题是该Proxy对象是从 plain 派生的Object，而不是从YARD::CodeObjects::Base所以没有[]=定义方法：

我应该如何将一些值从当前上下文存储到Proxy对象，以便它们在对象实际实例化期间可用？

我正在寻找支持以下功能的文档框架：

• 从代码注释生成
• 可搜索
• 造型可定制
• NTH：链接引用（如果我在某处引用某个类，则类名应链接到类文档）

我想用它来记录我正在处理的 RESTfull API

我知道 YARDoc，但很高兴收集一些替代品

是否有约定表明 YARD 样式文档中的参数仅用于其“真实性”状态，即您只想知道它false是否nil真实？

什么通常代替Truthy以下内容？

我在文档中能找到的最接近的是布尔值，这并不是我真正想要的。

我正在写我的第一个 gem，我正在用 YARD 记录它。我已经让我的一个类有一个构造函数，它需要一个不带参数的块¹。

YARD 提供@yield [params] description标签来根据方法将传递给它的参数来描述块参数，但如果params列表为空，则格式不正确。我应该如何记录没有参数的块？

¹：从技术上讲，我什yield至不知道；我的代码如下所示：

...因此该块包含要在新创建的对象的上下文中运行的代码。如果出于某种原因这是一个糟糕的主意，我也很高兴知道这一点:)

我正在使用带有 Markdown 的YARDoc来记录我的 Ruby 代码，并且希望在方法的文档中包含一个无序列表（HTML“项目符号”）。这是我到目前为止所拥有的：

我正在使用以下方法生成文档：

但它不会生成 HTML 项目符号，它将星号 ( *) 视为文字字符。生成的doc/Foo.html文件包含：

如何在 YARD 中使用 Markdown 插入 HTML 项目符号？我本质上希望上述输出中的每个字母都包含在 中，并且列表被一个元素<li>...</li>包围。<ul>