问题标签 [yard]

有没有办法在 heroku 上安装 Yard (http://yardoc.org/guides/index.html) 服务器？我在文档中没有找到任何解释如何做的东西。

非常感谢

我正在记录一个项目，基本上我有类似以下内容：

我正在设置多种方法，类似于我在哪里实现 foo 他们正在返回 bar 的返回。一个例子如下：

但是假设我将bar返回的内容更改为整数，那么我的文档不正确。我熟悉在 YARD 中记录 DSL，但是在描述另一种方法时，您如何指定#bar@return.type方法的返回类型。bar我所指的一个例子如下：

最终，我想要完成的是记录我的代码，而不必定义像返回类型这样的绝对值，这取决于另一种方法的定义。

更新：我发现您可以调用# @return (see #bar)并让它列出返回或与foo方法相同的bar方法，但我无法确定如何简单地获取正在返回的类型和/或重载返回的描述bar带有自定义描述foo。

我同时使用 Python 和 Ruby，我真的很喜欢 Ruby 的 Yard 文档服务器：

http://yardoc.org/ ,

我想知道 Python 世界中是否有等价物？“pydoc -p”真的很旧，丑陋且使用起来不舒服，而且看起来Sphinx和Epydoc不支持服务器模式。

你知道任何等价物吗？

谢谢

如果我在一个文件中有以下内容：

用 get 定义的方法property正确记录。但是，如果我在单独的文件中有这些定义，则无法正确生成文档，例如以下情况：

file0.rb：

file1.rb：

file2.rb：

当在单独的文件中时，Yard 宏在生成文档时不会保留。如何实现这一点？

我正在寻找迭代 yardoc 寄存器的方法@macro。我知道您可以按如下方式使用它们：

并且您可以生成由逗号分隔的寄存器表示的参数，就好像您正在获取数组的一部分，如下所示：

生成：foo(a, b, c)但returns (String) the return value of create_method_with_args我有兴趣调用类似的东西(${2--1}).each do |$arg|并做文档说每个参数都有一行文档。

这是我的设置：

• 红宝石 1.9.2 p290
• 码 0.8.1

文件夹结构不是宝石，只是简单的旧 Ruby 代码：

问题是 yard 没有看到任何文件。

yard doc产生这个输出：

任何想法为什么它看不到我的任何文件，或者不是

编辑（附加信息）：

Yard 确实有权创建文件。

运行yard doc命令后，我的目录显示 yard 文件：

编辑（回复关于 rdoc 的评论）

一旦我删除了 yard 创建的 doc 文件夹（rdoc 抱怨它）rm -rf doc，rdoc 就会生成文档并提供此输出

编辑（附加信息）

Yard 不适用于我的其他 ruby​​ 版本，包括 MRI 1.8.7 和 jRuby 1.6.4。它的行为方式与上述相同

我正在使用yard来生成我的项目的文档。即使文档可以生成，因此不需要进行版本控制，我们还是决定这样做，因为它可以更容易地查看代码（注释）更改对实际文档的影响。

问题是每次 yard 生成文档时，它都会更改每个文件开头的日期，导致所有文件都被视为已更改。

有没有办法告诉 git 忽略这些行以检测文件是否已更改，或者有一种方法可以将 yard 配置为如果它们相同则不重新生成文件？

谢谢

更新

我知道我可以做一个脚本或其他任何东西，如果只有日期发生了变化，它就会清理文件。所以我的问题是有一种 Git 方法可以做，即我应该费心阅读差异驱动程序还是应该执行干净的脚本。

如果我要走向清理路径，那么使用 git hook 或将其集成到 doc 生成中会更好吗？

最终，我对任何其他方式来跟踪由于生成的文档中的特定提交而导致的更改感兴趣。

我还没有真正解释我的问题是什么（以及为什么我要尝试对不需要的东西进行版本化）所以我们开始了。

有时，代码中的一些修改会搞砸文档，因此我将能够看到提交对文档的影响。

示例：我为 vim 使用模式行（文件第一行的注释告诉 vim 不同的信息）

知道我有一个包含模块文档的文件

在其他地方我使用这个模块

那时，一切都很好，A 的文档将是Documentation of module A. 但是，如果有人（比如我）删除了最后一个文件中的一个空行并只留下一个（是的，我在模式行和代码之间留了 2 个空行），那么院子认为模式行是模块 A 的文档，它将是vi : my vim setting.

问题是，除了查看每一页之外，没有办法检测到文档是否被搞砸了。使用 git，我可以快速查看和检查更改的内容，甚至可以找到更改的时间（这很重要，因为这样我就可以找出更改的原因）。

我对此真的很陌生，而且我一直在浏览YARD 文档，并且还没有真正找到解决我问题的方法。

这是我开始使用的代码：https ://github.com/spape/yard-rest-plugin效果很好，但我正在尝试为其添加一些功能。

基本上，我正在尝试添加一个过滤器，以便我可以包含一些模型文档，以便查看控制器 API 文档的人可以看到他们可以使用的模型的哪些属性。

插件 yard-rest 过滤掉任何没有@resource标签的方法。所以，我想，我会@resource_object为我的模型添加一个标签，我想在 API 文档中显示某些信息。

在插件的代码中。我在 /lib/yard-rest.rb 中找到

在那个文件中，我修改了reject_without_resource(list)方法

YARD::CodeObjects::ClassObject在我们关心的情况下，对象是 a 。object.meths是一个方法数组（方法对象）。并且方法对象有一个检测方法，它允许测试一个方法是否具有我们想要通过.has_tag?调用测试的任何标签。但是，我一直无法为班级找到类似的东西。现在，因为我不想在 API Docs 的模型中记录任何方法，所以我不想将 @resource 标记放在任何模型方法上。

我当前的 .yardopts 文件，表明我确实在搜索模型和控制器：

那么，如何更改过滤器，以便我可以包含模型？或者至少是类级别的标签？

当尝试为使用 Rails 实现的服务生成 YARD 文档时，我收到以下警告：

我的理解是 YARD 无法确定 mixin 的类型，因为它仅在运行时可用。

那么在这里做什么是正确的呢？是否可以正确记录mixin？如果没有，我该如何摆脱警告？

我试图记录一些 Ruby 代码yard，即使我正在做的正是这里或这里所描述的

我仍然收到这个奇怪的错误

然后生成的 html 看起来很奇怪。我这样称呼yard：

我可能做错了什么？