YARD和RDoc兼容性

2012-02-21 89 views 0 likes

如果我用YARD記錄我的代碼，並使用例如@overload標籤，和其他人安裝我的寶石，它與RDoc生成文檔，不會混亂嗎？YARD和RDoc兼容性

有沒有很好的方法來處理這個問題？

不是單向兼容？也就是說，YARD可以讀取RDoc，但不能反過來。大多數人在RDoc上使用YARD。 – sawa 2012-02-21 09:33:25

是的，這就是我所掌握的。但是看到外面的人可能仍然在使用RDoc並且沒有YARD，那麼當您使用YARD特定的標記來記錄代碼時，您如何迎合？ – mydoghasworms 2012-02-21 09:44:22

回答

是不支持@overload，但TomDoc作爲一個可行的之間。 RDoc現在支持TomDoc開箱即用，Yard擁有yard-tomdoc插件。對於大型項目，YARD仍然更好（IMO），但對於小型圖書館或工具，TomDoc可以很好地工作，並且可以被這兩個系統使用。

2013-01-28 09:32:01 trans

相關問題