以下は, Fortran 90/95 プログラムのドキュメント生成ツールの調査および それに関連して行った調査に関するメモ書きである. 雑多に並んでいるが容赦されたい.
URL は <URL:http://www.zib.de/Visual/software/doc++/>
C++, Java のドキュメント生成ツールらしい. Example を見ると, doxygen の ようにクラスの関係を図示することも可能なようだ. 詳しい比較は行なって いない.
富士通ソフトウェアテクノロジーズより「仕様書工房」 (<URL:http://jp.fujitsu.com/group/fst/services/frontier/kobo/>) と いうソフトウェアも存在する. 言語ごとに ￥ 38,850 (税込) のお値段らし い. (一応試用版なんてものもあるらしい)
Perl に関しては perldoc というソフトウェアが存在する. Perl スクリプト 内に POD (Plain Old Document) 形式のコメントを記述しておき, そのスクリ プトに perldoc コマンドをかけると, man で表示する形式などに変換して出 力する. man だけでなく, html に変換することも可能なので, Web 上から参 照する用にする事も可能である.
ただし, クロスリファレンスや, ソースコードの自動解析 (サブルーチンの引 数などを自動でマニュアルに出力するなど) はできないようだ. なので, Ruby にとっての RD と同じような位置づけと考えておくと良さそう. (RD に比べ て変換ツールはかなり充実している).
実際に POD フォーマットが含まれた perl スクリプトの例としては, debian sarge の perl パッケージに含まれる /usr/lib/perl/5.8.4/Encode.pm が良 い例である. ファイルの前半にはソースコードが, 後半にマニュアルが記載さ れている. これを perldoc コマンドで見る場合には,
$ perldoc Encode
とすると良い. (ただし, これはリアルタイムで Encode.pm を解析している のでは無いらしい. タイムスタンプを読む限り).
HTML にしたい場合, perldoc と合わせて pod2html を用いる. perldoc で -u オプションを付けると, POD 形式そのままで出力される. そのテキストファ イルに対して, pod2html をかけると HTML ファイルを出力してくれる.
$ perldoc -u -T Encode > Encode.pod $ pod2html --infile=Encode.pod --outfile=Encode.html
パイプを用いて以下のようにすることでも HTML への変換が可能である.
$ perldoc -u Encode | pod2html > Encode.html
HTML に関する「正しい表現」を参照するため, 以下の HTML 4.01 Specification の日本語訳を参照した.
「文書構造」という単語
「リスト」という単語
「見出し」という単語
Ruby 用 MathML ライブラリ作者の黒田 拓氏が EPnetFaN 座学編 & 森羅万 象セミナーで講演した際の発表資料.
Mathematical Markup Language (MathML) Version 2.0 (Second Edition)
MathML バージョン 2 の「正しい」仕様書. 和訳は下記参照
数学用マークアップ言語 (MathML) バージョン 2.0
上記ページの和訳.
ハウツー MathML
MathMLとは 【Mathematics Markup Language】 ─ 意味・解説 ： IT用語辞典 e-Words
e-Words による MathML 解説
MathML に対応したブラウザ: 北大文「魅力ある大学院教育」
2006/04 現在の MathML に対応したブラウザ一覧
