问题标签 [yard]

我决定将我的项目中的 README 文件转换为降价，并一直在使用 yard 验证呈现的文档是否正常。所以我安装了 rdiscount，将 README 更改为 README.md 并尝试：

这给了我一个警告：

所以我尝试了：

同样的问题。跑步：

提供更多信息：

如果我尝试使用纺织品，也会发生同样的事情。如果有人想尝试重现该问题，该项目在github 上。谢谢你。

现在 Yardoc 将生成如下文档：doc/ModuleName.html、doc/ModuleName/ClassName.html 和 doc/ModuleName/ClassName/method_name.html 我想知道如何调整serialized_path（无需猴子修补所有内容）以执行以下操作：doc /ModuleName/index.html doc/ModuleName/ClassName/index.html 和 doc/ModuleName/ClassName/method_name/index.html

我在 YARD doc 工具中使用宏，并且在某些文件上它们可以工作，而有些则不能。

例如，我在我的一个源文件中定义了一个宏。

然后在其他文件/类中我有：

当我运行文档生成器时，宏将适用于许多文件，但不是全部。我的猜测是文档生成器在生成失败的文档之前没有看到宏。一旦到达宏，它就适用于之后的每个文件。但这是一个猜测。

有没有办法确保宏适用于每个文件？我怀疑我认为宏在 YARD 中的工作方式与它们的实际工作方式之间存在脱节。

PS 对于那些不知道 YARD 是什么的人，你应该检查一下。它基本上完成了 rDoc 所做的工作，但要好得多。http://yardoc.org/

如果我想查看关于我的 gem 的文档，我可以这样做：

如何查看 Ruby 标准库的文档？

如何在生产服务器上运行 Yard 服务器？也许使用一些任务？从 capistrano 加载，使用乘客和 nginx，Jenkins(Hudson)。

我正在将我维护的 ruby​​gem 从 RDoc 切换到 YARD 文档。但是，代码中有一些重要的注释只需要保留在代码中，不应该出现在文档中。例如：

RDoc 尊重#--和#++门，但 YARD 没有。在 YARD 的标记中做类似事情的语法是什么（如果存在）？

我正在使用YARD为我的 ruby​​ gem 编写文档。在我的 gem 中，我有一些代码遵循这种常见的 ruby​​ 模式，其中一个模块包含在一个类中，并且该模块不仅添加了实例方法，而且还添加了类方法：

默认情况下，YARD 将为 Foo 类生成如下所示的文档：

我认为这个文档是不充分的，因为它没有告诉用户该Foo.hello方法可用。要了解hello，用户必须点击Moo，然后点击ClassMethods。

Foo在一页上列出所有类和实例方法的列表会很棒。我怎样才能做到这一点？我是否需要更改代码，或者是否可以添加一个标签来给 YARD 一个提示ClassMethods？

我正在开发一个 Ruby 编程教程，我想用Yard记录它。默认情况下，Yard 将模块/类中的所有方法按字母顺序排列。但是，由于本教程中每个模块中的方法是相互构建的，所以我想按照我编写它们的顺序来保持它们。

有没有办法配置 Yard不按字母顺序放置方法？

是否可以使用 YARD 来记录模板，还是需要文件中的类？我试过跑步

院子文档控制器/模型/视图/索引/

但索引视图没有被拾取。我看到要添加到文档中的额外文件的元数据，但显然不想呈现院子评论。我只想记录每个视图中使用的部分。

谢谢

我正在使用 Ruby on Rails 3.1.0，我正在尝试使用 YARD 0.7.4。我想记录常量值，所以在我的课堂上我这样说：

但我运行yardoc（或yard doc）命令后的 HTML 输出如下：

在上图中，HTML 文档的渲染/生成效果不佳，至少不像我预期的那样。我阅读了YAML 文档，但我仍然有一些问题：如何更好地说明和显示与常量值相关的文档？