相当于RDoc部分的YARD:

时间:2013-10-22 16:10:41

标签: ruby rdoc yard

有一个相当于RDoc部分,有YARD?

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

我想构建分类API,并且部分可能是实现它的好方法。

1 个答案:

答案 0 :(得分:3)

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

#@!<something>

以“!”为前缀的令牌,在此指令中 ,有:

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

你可以像以下一样使用它:

# @!group Rendering methods                                                                                                                                                                        

def render
  [...]
end

def pretty_render
  [...]
end

# @!endgroup      

它提供了我想要的:) 对不起,因为它在主文档中,

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