ruby - YARDとRDocの互換性

Question

YARDを使用してコードをドキュメント化し、たとえば@overloadタグを使用し、他の誰かが私のgemをインストールして、RDocを使用してドキュメントを生成した場合、結果は乱雑になりませんか？

これに対処する良い方法はありますか？

Answer 1

は をサポートしていません@overloadが、TomDoc は実行可能な仲介者として機能します。RDoc はすぐに使用できる TomDoc をサポートするようになり、Yard には yard-tomdoc プラグインがあります。大規模なプロジェクトでは YARD の方が優れていますが (IMO)、小規模なライブラリやツールでは TomDoc が適切に機能し、両方のシステムで使用できます。