appledocでプロジェクトのドキュメントをつくる
appledocは, iOS, MacOSXのソースコード(プロジェクト)のドキュメンテーションを作ってくれるツールです。
Appleのドキュメンテーションにそっくりなドキュメントを作成してくれます.
javadocのようなものです
インストール
gitからソースを持ってきて, 中に入っている.shをたたきます
gitがない場合は,別途インストールします
git clone git://github.com/tomaz/appledoc.git sudo sh install-appledoc.sh
Homebrewがインストールされている場合は非常に簡単です
brew install appledoc
※blewのインストールはシンプルです
ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"
ruby が入っていれば何の問題もありません
これでコマンドからappledocが呼び出せるようになりました(appledocというコマンドになりました)
※git式, homebrew方式両方試してみましたが, 特に問題ありません
コメントの形式
JavaDocと同様に, コメントの形式が決まっています
///
と
/** */
メソッドだと
/** @param param description @return BOOL return value description */
コメントのスタイルはいろいろな方が書いていらっしゃいます
CocoaNetics
Developers.IO
使い方(デフォルトのApple Docに入れる場合)
appledoc -p ProjectName -c Company --keep-undocumented-objects --keep-undocumented-members source
–keep-undocumented-objects はコメントのないクラスなどもドキュメントにするためのオプション
–keep-undocumented-members はコメントのないメソッドもドキュメントにするオプションです
この形式で作った場合, XCodeのドキュメントの枠組みで
~/Library/Developer/Shared/Documentation/DocSet におかれます。
開くには, XCode経由であけるかもしくは, 外部ツールを使うか, 右クリックコンテンツ表示で開くかいずれかです
使い方(HTMLにする場合)
上のように, AppleDocにしてしまうと柔軟性が失われてしまうので, HTMLで形式するのもありでしょう
appledoc -p ProjectName -c Company --keep-undocumented-objects --keep-undocumented-members --create-html --no-create-docset source
source はソースファイルのディレクトリ, ProjectNameはプロジェクトの名前, Companyは会社名です
出力先を指定する場合は -o オプションを使います
デフォルトでは実行ディレクトリ上にhtmlという名前で出力されます
例
筆者が作成したアプリ, Colomemoというアプリで試してみました
コマンドは, こんな感じ
appdoc -p Colomemo -c atmarkplant --keep-undocumented-objects --keep-undocumented-members --create-html --no-create-docset Colomo/Colomo
できたものがこちら
