NAMAKESUGI | YARDがすごい
FlexやRuby on Railsなどで使い方とかを自分が後でわかるようにメモしておくブログ。最近はFlex系に飽きてます。 [ruby]rdocは捨て去られてYARDになった[gem] 皆さんはrubyやrailsのドキュメントをどのように作成されていますか？ rdocだとjavadocみたいなことができないーーーということに悩んでいませんか？ そんなときにはこれをお試しください。 yardとは rdocの進化版 すごく綺麗なリファレンスが作成できます 参考URLとしてyardの凄さを表したのがこのページです。 => Gemリファレンス Gemに登録されているライブラリをyardで表示しています。 インストール 今回利用したのは0.6.4です。なおrdocの生成を勝手にしますが、失敗します。 gem install yard ドキュメント生成方法 RAILS等のルートディレクトリで実行
rgss-lib コメント規約
Last update : 2005/12/06 目次 １．はじめに ２．コメントの挿入箇所について ３．コメントの書き方 ３．１．ファイルヘッダ ３．２．クラス/モジュールヘッダ ３．３．メソッドヘッダ ３．４．ネームスペース、定数、クラス/モジュール変数 ３．５．プロパティ ３．６．定義変更メソッドについて ４．アウトライン ５．RDocの使用方法 更新履歴 2005/12/06 和希 第１版発行 2005/12/03 和希 新規作成 １．はじめに rgss-libではRDocスタイルにてコメントを記述しています。 RDocスタイルではクラス、モジュール、関数などについて指定された書式の コメントをHTMLなどで出力し、APIリファレンス化することが出来ます。 → Java/C++なんかのDoxygenに近いです。 詳しくはこちら(公式・英語)をご覧ください。 ２．コメントの挿入箇所に
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ページを開く
