YARD 和 RDoc 兼容性
如果我用 YARD 记录我的代码，并使用例如 @overload 标签，而其他人安装我的 gem 并使用 RDoc 生成文档，结果会不会很混乱？
有没有好的办法来处理这个问题呢？
If I document my code with YARD, and use e.g. the @overload tag, and someone else installs my gem and it generates the documentation with RDoc, won't the result be messy?
Is there a good way to deal with this?
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（1）
它不支持
@overload，但 TomDoc 可以作为一个可行的中间人。 RDoc 现在支持开箱即用的 TomDoc，并且 Yard 具有yard-tomdoc 插件。对于大型项目，YARD 仍然更好（IMO），但对于小型库或工具，TomDoc 效果很好并且可以被两个系统使用。Is doesn't support
@overload, but TomDoc serves as a workable go between. RDoc now supports TomDoc out of the box, and Yard has yard-tomdoc plugin. YARD is still better (IMO) for large projects, but for small libraries or tools TomDoc works well and can be used by both systems.