これは, Fortran 90 ソースコードを HTML 化する Perl プログラム f90tohtml を使ってみての感想である.
ちなみに, この他にも, Fortran 90 ソースコードからからドキュメントを自 動生成するツールとして, f90doc や RDoc Fortran 90/95 ソースコード解析機能強化版 といったものがある.
f90doc を使ってみての感想 などというものもあるので参照していただきたい.
<URL:http://mensch.org/f90tohtml/>にて 公開されている. 特にライセンスは明示されていない.
ダウンロードして展開すること自体は (まあ当然ながら), 簡単でし た. あまりシステムへのインストール, ということは考えられてないよ うです. (まあ手動でやってね, という感じです).
「まずサクッと使ってみよう」には少し手間取りました. rdoc のようにとり あえず起動するとカレントディレクトリ + サブディレクトリ以下を探査する, というのではなく, ちゃんと「ソースファイルのリスト」を書いたファイルが 要り, しかもそのソースファイルのリストファイルがどこにあるのかを記述し た設定ファイルも必要なため, まずはその構造を理解するのに少し時間が必要 でした. (サンプルもあるんだけど, 結局これが理解できないと動かせなかっ た...)
ソースコードの解釈自体は gt4f90io みたいにい ろいろ凝ったプログラムに関してもサクサクやってくれました. エラーも出ず にちゃんと HTML 出力してくれました.
ソースコードブラウザとしてはかなり便利なのではないかと. コメントに関し ても rdoc-f95 的に subroutine など定義文直下に記述するようにすると, いい感じにその文書も読めます. (もちろん本当に「コメント」としてですけど). 簡単に特徴を述べると,
ってとこでしょうか. (実際に以下の サンプル を参照すると良いでしょう.)
ただ, いちゃもん付けるとすると以下の通りでしょうか.
関数の総称名は完全に無視.
gt4f90io のようにいろいろ関数を凝って作っているプログラム的にはこれがツライ.
PRIVATE, PUBLIC は完全に無視.
ライブラリなりモジュールなりを利用する第三者が読むマニュアルを 自動生成, というわけにはいかないみたい.
凝って f90 でオブジェクト指向的に書こう, なんぞと思わなければまあ普通 に使えると思う. (ってことは普通「使える」っていうのだろうなぁ... ^^;)
でもまあ「リファレンスマニュアル」はやっぱり別途書きたくなりそうだけど. (ソースコードをだら〜っと全部読ませる, というのは, 多分第三者が利用す るものとしては冗長すぎる, というんですかね. もちろん, ちゃんとコメン ト書くようにすれば無いより全然ましなものですけど).
gtool4 プロジェクトにて配布される Fortran 90 データ I/O ライブラリ gt4f90io の f90tothml 製ドキュメント.
f90tohtml のホームページでは, ``the University of Oklahoma's ARPS model, the PSU/UCAR MM5, the NCEP Regional Spectral Model, the Navy's COAMPS model, and the new community WRF model.'' と記載されている.
以下, 実際に探してみて見つかった f90tohtml を利用している気象モデルのリスト.
