appledoc (その2)

Mac

Gentle Bytes - appledoc - Objective C API documentation generator
先日紹介したappleのリファレンスドキュメント風のHTMLをソースコードコメントから生成する"appledoc"だが、MacBook Airでも普通に動いた。

紹介した際には64bitがビルドターゲットだったので無理みたいなことを書いたが、最新のMacBook Airは64bitカーネルを使用しており、元々問題は無かったのである。

ということで試してみた。

AddressBook.h


このようにクラスヘッダ(AddressBook.h)にappledocで処理可能なようにコメントを書いてコンパイルしておく。

appledocを実行し上手く行くと、以下のようなHTMLができあがる。

出力結果


おお、中々にそれっぽいな。日本語も通るし使えそうだ。

ディレクトリ構造は以下のようになっており、ターゲット下にクラス毎にHTMLファイルを生成するようになっているようだ。

今回はコメントをヘッダ側に書いたが、実行側に書いても処理されるようで、どちらに書くのが真っ当なのか、まだよく分かっていない。また、プロパティに大してインラインコメントを記述してみたのだが、これが反映されていないようだ。

使えるのは分かったので、もう少し詳しくコメントの書き方を調べてみよう。※

※appledocが使えない場合はDoxygenを使おうと思っていた。