MOONGIFT: � Wikiのように開発者向けドキュメントを共有する「DocBox」:オープンソースを毎日紹介
プログラマのためのドキュメントと言えば、JavaDocやRDoc、PHPDocなどが有名だ。これらはソース上にコメントとして書けるので、実際のコーディングとドキュメントとが乖離するのを防ぐことができる。 RDocを閲覧できる だがそれらのドキュメントをいちいち生成していたのでは面倒だ。編集の手間も軽減するこれを使ってみよう。 今回紹介するオープンソース・ソフトウェアはDocBox、RDocコラボレーションソフトウェアだ。 DocBoxはRDocをまるでWikiのように扱うことができるソフトウェアだ。ソースコードをDocBoxにインポートして動作する。ドキュメントはWikiのようにWebベースで編集が可能だ。 Web上で編集できる 編集した内容は元のソースコードへの反映したり、Gitリポジトリのドキュメントブランチへのコミットができるとのこと。*.rbファイルや、READMEファイルが対象に
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ページを開く
