↓ Skip to main content

rbs-inlineの宣言とYARDのドキュメントを共存させる当面の方法

rbs-inlineのDoc style syntaxはYARDで記述できる情報と似ています(@param @return など)。そこでyardが出力するドキュメントにrbs-inilineの情報を残す方法としては次のようにすれば良いです。

  1. yardのドキュメントとrbsの型宣言の情報を以下のような感じで混ぜて記述する。rbs-inlineはこれで解釈してくれる

https://gist.github.com/ohai/6388bb6d9c84168b9b8bd83b6521f84f

  1. yardoc のコマンドラインに –tag rbs:rbs を渡す。以下のような感じ

     yardoc lib/**/*.rb --tag rbs:rbs
    
  2. 出力されるhtmlは以下のようにレンダリングされる。

YARDのプラグインを作るのがよりよいやりかただとは思いますがまあとりあえずはこんなんでもいいのではないでしょうか。