Apple公式みたいな見た目のコードリファレンスが生成できる、appledocを試してみた

appledoc は、Objective-c のソースコード内の書式に従って記入したコメントからリファレンスを作成するツールです。
ウリはApple公式ドキュメント風の美しいデザイン。
仕事でなければコードリファレンスなど作成することはそうそうありませんが、ちょっとコメント形式を気をつけるだけで自動で作ってくれるなら導入する価値はあるかもしれません。
MOONGIFT さんで紹介されていたのを見て良さそうなので試してみました。
似た感じのものだと doxygen とか。doxygen ほど多機能ではないようですけど。

MOONGIFTさんの記事はこちら↓

Apple公式ドキュメント風のコードリファンレンスを生成「appledoc」 - MOONGIFT|オープンソース・ソフトウェア紹介を軸としたITエンジニア、Webデザイナー向けブログ


手順

1. appledoc をダウンロード。


2. ビルドしてパスが通っている場所に設置（/opt/local/bin とか）。


3. ~/Library/Application Support/appledoc フォルダを作ってダウンロードしたフォルダ内の Templates から docset、html の2フォルダをコピー。


4. コレを見ながら GlobalSettings.plist を作成して、上記で作成したフォルダに設置。


5. AppledocSettings.plist も作ってリファレンス作成対象のプロジェクトフォルダに置く。GlobalSettings.plist は各プロジェクト用の設定ファイルで上書きできるよう。


6. ターミナルで appledoc --output 書き出すパス プロジェクトパス

とりあえずダウンロードした appledoc プロジェクトフォルダからコードリファレンスを作ってみるとどんな感じか判りやすいかも。

自分のプロジェクトにコメントを書いてみて、コードリファレンス生成。
リファレンスが立派なので一瞬ちゃんとしたプロジェクトに見えました！




by T