使用Ruby的Yard doc工具,我可以将Yard配置为* not *按字母顺序放置方法吗?

时间:2012-01-16 03:43:22

标签: ruby documentation yard

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

有没有办法按照字母顺序将Yard配置为而不是放置方法?

1 个答案:

答案 0 :(得分:2)

默认模板不提供使方法名称保持未排序的选项。

您可以选择创建自定义模板或修补默认模板。

如果它有助于排序方法的行是: https://github.com/lsegal/yard/blob/master/templates/default/module/setup.rb#L39