yard

1热度

1回答

动态文档，在另一个YARD的描述中使用返回方法？

我记录一个项目，essientially我有类似下面的内容： def foo return bar(__method__) end def bar (method) return method.to_s + 'somestring' end 我设立的方式类似，我已经实现foo其中，他们是他们正在返回酒吧的回归方法，众说纷纭。一个例子如下： # The description

ruby documentation yard 2012-04-25

---

2热度

1回答

如何从另一个参数引用参数（'@参数'标签）？

我正在使用Ruby on Rails 3.1.0和YARD 0.7.4 gem进行文档编制。我想参考参数（@param标签）来自另一个参数。也就是说，我有： # ... # # @param [String] argument_1 # Here I would like to have a description text with a reference/link to the # 'a

ruby-on-rails ruby documentation reference yard 2012-01-19

---

0热度

1回答

如何生成与我的插件相关的文档？

我正在使用Rails 3.1.0，并且已经实现了一个工作插件。除了它应该完成之外，其相关文件位于ROOT_APP/vendor/plugins/my_plugin目录中。 现在，我正在使用YARD 0.7.4宝石，并且我想记录该插件。无论如何，当我运行yardoc（或yard doc）命令时，似乎不考虑我的插件，因此不会生成相关文档（仅生成与“主”应用程序相关的文档）。 如何生成与我的插件相关的文

ruby-on-rails ruby ruby-on-rails-3 documentation yard 2012-01-20

---

2热度

1回答

如何使用YARD服务器显示私有方法？

我的第一个问题，我发现--private开关不工作yard server，所以如何使它工作？ 第二，我注意到，--private开关适用于yard doc，如果我选择使用yard server的使用yard doc生成的DOC文件，而不是，如何使渲染文档具有框架（边栏）

yard 2012-01-22

---

2热度

1回答

如何在Yard文档中输出HTML元素名称

我想在Yard生成的ruby类文档中包含一些HTML元素名称，如<label>。但它不起作用。例如，句子 # Returns a <label> field... 由堆场 Return a field... <label>该元件实际上是通过逐字通过堆场能够进入浏览器作为原始HTML变为处理之后。 我试着用<label>来代替，结果这个文件中有<label>。 谢谢！

ruby-on-rails ruby documentation yard 2012-01-28

---

1热度

2回答

JavaScript文档生成器像RubyDoc.info或YARD？

我真的需要一个不错的Javascript文档生成器，用于即将推出的JavaScript库。显然，为了让人们了解它，我需要为我的图书馆提供文档。我在寻找一个好的文档库方面遇到了很多麻烦，我查看了许多不同的项目，但它们不是我所需要的。 是否有任何不错的JavaScript文档生成器，在Javascript中创建Rubydoc.info或YARD样式的文档？谢谢。

javascript documentation yard 2012-03-23

---

5热度

1回答

在YARD中有多种方法的文件鸭类型

YARD允许我指定方法参数和返回值的类型。因为我非常喜欢duck类型，所以很高兴看到YARD还支持通过指定它们必须支持的方法来定义类型。 正如你可以看到here，像 #first_method, #second_method这样的表达式被解释为逻辑分离。这意味着对象需要支持#first_method或#second_method或两者。这不是我需要的。 我希望能够指定一个对象需要同时支持#firs

ruby documentation yard 2012-02-03

---

4热度

1回答

如何记录除`README`文件以外的更多文件？

我正在使用Ruby on Rails 3.1.0和YARD 0.7.4 gem进行文档编制。我想补充的其他文件超过上生成的文档的顶部README文件提出here（见README，What's New?，Getting Started Guide，Architecture Overview，... 标签在链接页面顶部的“文件列表下“ 部分）。 也就是说，默认情况下，YARD gem似乎只生成与我的R

ruby-on-rails ruby ruby-on-rails-3 documentation yard 2012-02-18

---

0热度

1回答

YARD和RDoc兼容性

如果我用YARD记录我的代码，并使用例如@overload标签，和其他人安装我的宝石，它与RDoc生成文档，不会混乱吗？ 有没有很好的方法来处理这个问题？

ruby rdoc yard 2012-02-21

---

4热度

2回答

Heroku上的运行场服务器

有没有办法在Heroku上挂载Yard（http://yardoc.org/guides/index.html）服务器？ 我没有在文档中找到解释如何去做的任何内容。 非常感谢

ruby-on-rails-3 heroku yard 2012-04-11

---