YARD和RDoc兼容性

Question

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

有没有好办法解决这个问题？

Answer 1

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