ITエンジニア/デザイナ向けにオープンソースを毎日紹介

YARDはRubyのコードからドキュメントを生成するライブラリです。

システム開発をしていて一定以上の規模になるとどうしてもドキュメントが欲しくなってきます。それは最低限必要なドキュメントの一つです。今回はコード中に書き込んだコメントからドキュメントを生成してくれるYARDを紹介します。


インストールしました。


yardocコマンドでドキュメントを生成します。docディレクトリの中に生成されます。


コントローラやモデルが一覧されています。


メソッドやサブクラスなどが表示されています。


サーバとして立てることもできます。


クラスリストはメニューから。


メソッドのリストも取れます。

YARDは次世代のrDocとして期待されているドキュメントシステムになります。@〜という形でパラメータや返り値、サンプルコードなどを記述します。サーバとして立ち上げて、プレビューしながら書いていけばドキュメント作成がさくさく進むのではないでしょうか。

YARDはRuby製、MIT Licenseのオープンソース・ソフトウェアです。


MOONGIFTはこう見る

システム開発において、ムダなドキュメントを作成する必要はありませんがドキュメント全体が無用という訳ではありません。特にこの手のメソッドの説明などを記述した文書は、システムの処理を知る上でも大事なドキュメントになるでしょう。コードを見れば分かる、は相当投げやりです。

そのような運用をしているとメソッドの書き換えすら難しくなります。期待されている処理が明文化されていれば、そのメソッドを利用して処理を行うのも難しくありません。また文書化が難しいメソッドであればリファクタリングする等といったルールも適用しやすくなるでしょう。

YARD - A Ruby Documentation Tool

lsegal/yard · GitHub

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2