タグ

documentとrubyに関するhiroponzのブックマーク (2)

  • Rails/Rubyドキュメントをキレイに生成するYARD、早見表付き! 

    RubyRailsのドキュメントを生成するGem YARDをご存じですか? ドキュメント生成GemではrDocが不動の一番すが、その後ろで猛追しているYARDというGemがあります。今回はこのGemの紹介です。 (02/16 23:30) Ruby 2.1で動作確認しつつリニュアール 🏀 GemのイントロYARDはRubyのドキュメント生成rDocの次世代を期待されているGemです。 Ruby/Railsのコード内にYARDの書式でコメントを書くと、メソッドや引数、戻り値などの解説をうまく表示してくれます。 まずGemをインストールします。

    Rails/Rubyドキュメントをキレイに生成するYARD、早見表付き! 
  • いますぐ始める RDoc によるドキュメント生成 - WebOS Goodies

    先日公開した Ruby 用 JSON クラスを RubyForge にスニペットとして登録しました。使い方も書かないで登録しても意味がないので、この機会に今まで興味がありながら手が出せなかった RDoc を使ってみました。これがもう驚くほど簡単で、なんで今まで使わなかったのかー!!と後悔しきりです。そんなわけで、私のようにわず嫌いをしている方に向けて、「30 分で始める RDoc」を目標に(あくまで目標^^;)使い始めの手引きを書いてみました。まだ RDoc をご利用でない方、挑戦してみてはいかがでしょうか。 なお、すでに Ruby 一式がインストール済みで、最低限の Ruby の知識があることを前提にしていますので、あらかじめご了承ください。 まず最初に、 RDoc について軽くご紹介しておきます。すでにご存知の方は読み飛ばしてください。 RDoc は Ruby 専用のドキュメント生成

  • 1