使用 Ruby 的 Yard 文档工具,我可以将 Yard 配置为*不*按字母顺序放置方法吗?
我正在开发一个 Ruby 编程教程,我想用 Yard 记录该教程。默认情况下,Yard 将模块/类中的所有方法按字母顺序排列。但是,由于本教程中每个模块中的方法都是相互构建的,因此我希望按照我编写它们的顺序保留它们。
有没有办法将 Yard 配置为不按字母顺序排列方法?
I'm developing a Ruby programming tutorial which I'd like to document with Yard. By default, Yard puts all methods in a module/class into alphabetical order. However, since the methods in each module in the tutorial build upon one another, I'd like to keep them in the order I wrote them.
Is there a way to configure Yard to not put methods in alphabetical order?
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(1)
默认模板不提供使方法名称不排序的选项。
您可以选择创建自定义模板或修补默认模板。
如果有帮助,则对方法进行排序的行是:
https://github.com/lsegal/yard /blob/master/templates/default/module/setup.rb#L39
The default template does not provide an option for leaving the method names unsorted.
Your options are to create a custom template or patch the default one.
If it helps the line that is sorting the methods is:
https://github.com/lsegal/yard/blob/master/templates/default/module/setup.rb#L39