ruby - YARD 和 RDoc 兼容性

Question

如果我用 YARD 记录我的代码，并使用例如@overload标签，然后其他人安装我的 gem 并使用 RDoc 生成文档，结果会不会很混乱？

有什么好的方法可以解决这个问题吗？

Answer 1

是不支持@overload的，但 TomDoc 可以作为一个可行的过渡。RDoc 现在支持开箱即用的 TomDoc，并且 Yard 有 yard-tomdoc 插件。YARD 对于大型项目仍然更好（IMO），但对于小型库或工具，TomDoc 运行良好，并且可以被两个系统使用。