見やすいリファレンス生成。Ruby製のドキュメントシステム·YARD MOONGIFT
YARDはRubyのコードからドキュメントを生成するライブラリです。 システム開発をしていて一定以上の規模になるとどうしてもドキュメントが欲しくなってきます。それは最低限必要なドキュメントの一つです。今回はコード中に書き込んだコメントからドキュメントを生成してくれるYARDを紹介します。 インストールしました。 yardocコマンドでドキュメントを生成します。docディレクトリの中に生成されます。 コントローラやモデルが一覧されています。 メソッドやサブクラスなどが表示されています。 サーバとして立てることもできます。 クラスリストはメニューから。 メソッドのリストも取れます。 YARDは次世代のrDocとして期待されているドキュメントシステムになります。@〜という形でパラメータや返り値、サンプルコードなどを記述します。サーバとして立ち上げて、プレビューしながら書いていけばドキュメント作成
YARD - A Ruby Documentation Tool
What Is YARD? YARD is a documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions. Above is a highlight of the some of YARD's notable features. And of course YARD comes with muc
はてなブログ | 無料ブログを作成しよう
吹奏楽コンクール リウマチの調子が悪い！薬の副作用もやばい！ 副作用のせいでご飯が全然食べられなくなって顔から痩せていくんだけど、お腹とかお尻から痩せたらいいのに。蓄えがあるから多少痩せたってちょうどいいくるいやけど、幸薄そうに見えるから顔は太ったままがいいなぁ。 お…
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
