f90doc を使ってみての感想

これは, Fortran 90 プログラムのドキュメント生成 Perl プログラム f90doc を使ってみての感想である.

ちなみに, この他にも, Fortran 90 ソースコードからからドキュメントを自 動生成するツールとして, f90tohtmlや RDoc Fortran 90/95 ソースコード解析機能強化版 といったものがある.

f90tohtml を使ってみての感想 などというものもあるので参照していただきたい.

1. 公開 URL
2. 使ってみての感想
3. サンプル

公開 URL

<URL:http://theory.lcs.mit.edu/~edemaine/f90doc/> にて 公開されている. MIT license にて配布されている.

使ってみての感想

• コメントの書き方は rdoc-f95 とは逆に定義文の上に書く. (rdoc Ruby パーサや Javadoc と同じかな?)
  • コメントの書式は "smarlty" フォーマット (javadoc に似せてあるらしい), で, 少なくとも <pre> 表示やリスト表示は可能らしい. (リンクないのかな... 無いとしたらかなり痛いですねぇ....)
• ドキュメントに反映するコメントの行頭には "!!" をつける.
• (かなり問題点) 2 箇所で同じ総称名の interface 文があると エラーを返して終了する. (例えば gt4 では Open という総称名を an_generic, gtdata_generic で 使ってるので, 解析できずに終わります. f90 的には問題ない使い方の はずなのだが...)
• (不満な点) 目次が作成されない. (手作りせなあかん).
• (グッド) 構造体は定義をちゃんと書き出してくれる.
• (グッド) ちゃんと public と private を解析して出力する.
• (グッド) use 文がハイパーリンクに変換され, 別のモジュールに飛べる

サンプル

gtool4 プロジェクトにて配布される Fortran 90 データ I/O ライブラリ gt4f90io の f90doc 製ドキュメント. なお, 上記に 記述されるとおり, 別のファイル内で同じ手続き名に対してinterface による 多重定義を行なうとエラーを生じて停止するため, ソースコード全てに 対してのドキュメントは生成されていない.

• gt4f90io ドキュメント by f90doc (目次無し)

Yasuhiro MORIKAWA / GFD Dennou Staff
Last Updated: 2006/07/11 (森川 靖大), Since: 2006/07/11 (森川 靖大)