【问题标题】:YARD and RDoc compatibilityYARD 和 RDoc 兼容性
【发布时间】:2013-01-28 17:32:01
【问题描述】:

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

有什么好办法解决这个问题吗?

【问题讨论】:

  • 不是一种方式兼容吗?也就是说,YARD 可以读取 RDoc,但反之则不行。大多数人更喜欢 YARD 而不是 RDoc。
  • 是的,这就是我的意思。但是看到人们可能仍在使用 RDoc 而没有 YARD,当您使用 YARD 特定的标签来记录您的代码时,您如何满足这一点?

标签: ruby rdoc yard


【解决方案1】:

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

【讨论】:

    猜你喜欢
    • 2011-04-11
    • 1970-01-01
    • 2014-09-24
    • 2012-02-14
    • 2012-10-11
    • 2015-01-19
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多