ruby - RDoc 部分 : 的 YARD 等效项

标签 ruby rdoc yard

有一个与 RDoc 部分等效的内容,With YARD ?

参见http://www.ruby-doc.org/stdlib-1.9.3/libdoc/rdoc/rdoc/RDoc/Context/Section.html

我想构建分类 API,而部分可能是实现这一目标的好方法。

最佳答案

好吧,我刚刚在 Yard 中发现了我以前不知道的功能:指令:

#@!<something>

在本指令中, token 以“!”为前缀 ,有:

#@!group <a group>
#@!endgroup

你可以这样使用它:

# @!group Rendering methods                                                                                                                                                                        

def render
  [...]
end

def pretty_render
  [...]
end

# @!endgroup      

它提供的正是我想要的:) 抱歉,因为它在主文档中,

http://rubydoc.info/gems/yard/file/docs/Tags.md (参见指令)

关于ruby - RDoc 部分 : 的 YARD 等效项,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/19523022/

相关文章:

ruby-on-rails - 在 RoR 中对 UTF-8 字符串进行排序

ruby - 如何在没有actionview的情况下实现form_tag助手?

ruby-on-rails - 如何让专家政策更干?

ruby-on-rails - 如何通过连接表过滤 ActiveAdmin 索引列表?

ruby-on-rails - 如何使用 markdown 文件作为 rdoc 的主文件(在 Rails 项目中)?

ruby-on-rails - 在 Fedora 12 上安装 rdoc、irb、bluecloth、chronic 时出现问题

ruby - 安装新 Ruby gem 时 RDoc::TopLevel:Class 的未定义方法 `reset'

ruby - 如何在 YARD 中引用当前类作为返回类型?

ruby - 不带参数的文档 block

ruby-on-rails - 可以使用 YARD 来记录 erb 模板