Objective-C (iOS): ドキュメンテーション

Apple Doc を使ってドキュメンテーションを行います。

/**
 * ほげほげ
 * @param number 数値の引数です。
 * @return 返り値です。
 */
- (NSInteger)convertHogehoge:(NSNumber *)number;

という JavaDoc 的な記述を書いておきます。.h / .m どっちでも良いようです。

Mac に環境をインストール

Homebrew で環境を入れてしまいましょう。

ターミナルを起動して

brew install appledoc

これで apple doc のインストールは完了です。

Apple Doc 生成

ターミナルでコマンドで簡単に生成できます。

生成したい Xcode プロジェクトディレクトリの中で、

appledoc --project-name ProjectName --project-company CompanyName --create-html --no-create-docset --output ~/docs/ProjectName .

最後ピリオド(.)を付けて、今いるディレクトリ配下を対象にすることを示していますので、付け忘れにご注意です。

ちなみに --no-create-docset を取ると、Xcode のヘルプにも自分で作ったドキュメントがインストールされます。

詳しくは Qiita のこの投稿が参考になります。
http://qiita.com/items/c97c59d93fe67d748055