いますぐ始める RDoc によるドキュメント生成 - WebOS Goodies
先日公開した Ruby 用 JSON クラスを RubyForge にスニペットとして登録しました。使い方も書かないで登録しても意味がないので、この機会に今まで興味がありながら手が出せなかった RDoc を使ってみました。これがもう驚くほど簡単で、なんで今まで使わなかったのかー！！と後悔しきりです。そんなわけで、私のように食わず嫌いをしている方に向けて、「30 分で始める RDoc」を目標に（あくまで目標＾＾；）使い始めの手引きを書いてみました。まだ RDoc をご利用でない方、挑戦してみてはいかがでしょうか。 なお、すでに Ruby 一式がインストール済みで、最低限の Ruby の知識があることを前提にしていますので、あらかじめご了承ください。 まず最初に、 RDoc について軽くご紹介しておきます。すでにご存知の方は読み飛ばしてください。 RDoc は Ruby 専用のドキュメント生成
RDoc による自動ドキュメント生成
RDoc とは? 概要 インストール サンプル Ruby スクリプト作成 RDoc によるドキュメント生成 RDoc の便利な機能を使ってみる RDoc ドキュメントのサンプル 参考資料 RDoc とは? Ruby Documentation System (RDoc) とは, Ruby で書かれたソースコードから ドキュメントを自動生成する, Ruby 本体に付属する標準ライブラリの1つです. RDoc は Ruby ソースコードを解析し, クラス, モジュール, メソッドの定義 を抜き出し, include や require に関して解釈します. そしてこれらの内容 とその直前に書かれたコメントを併合し, HTML ドキュメントを出力しま す. 詳しくは参考資料 1,2 を参照ください. 概要 以下では, まず RDoc のインストールを行います. そして Ruby で簡単なクラ ス
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
