appledocでObjective-Cプロジェクトのドキュメントを生成

こんにちは！商品企画部の池端です。

商品企画部なのにtech系の内容ですが、気にせず行きましょう！

Objective-Cのプロジェクトからドキュメントを自動生成したい。

javadocみたいなやつね。

Doxygenなんかを使ってもできそう。

DoxygenはC++、C、Java、Objective-C、Python、IDL、PHP、C#、D、ActionScriptなどに対応したスグレもののドキュメント生成ツールなんだけど、なんか設定とかめんどそうなのでスルー。

今回はappledocを利用することにしました。

生成されるドキュメントがappleのAPIリファレンスと同様のデザインで見た目がカッコいいのと、doxygenより導入や使い方が簡単そうだったので、、

（つかってみて、実際カンタンでした！）

web上には先達者達によるappledocに関する貴重な情報が！

いろいろ参考にさせていただきました。ありがとうございます！

iOS - appledocでドキュメント生成 - Qiita

appledocでプロジェクトのドキュメントをつくる | Professional Programmer

appledocの詳細は上記サイトをご覧頂くとして、ここではドキュメント生成に最低限必要な導入、使い方をご紹介します！

導入

(1)gitからソースコードを持ってきます。

git clone git://github.com/tomaz/appledoc.git

(2)appledocというディレクトリができるので、そこに移動してビルド＆インストール

cd appledoc
sudo sh install-appledoc.sh

使い方

appledoc -p ProjectName -c Company --keep-undocumented-objects --keep-undocumented-members --create-html --no-create-docset --output output-dir project-dir

ProjectNameはプロジェクト名、Companyは会社名で、生成されるドキュメントのヘッダ部分に反映されます。

--keep-undocumented-objects --keep-undocumented-membersは、コメントなしのクラス、メソッドも対象にするオプションです。

--create-html --no-create-docsetは、htmlのドキュメントを生成するオプションです。

output-dirには、ドキュメント出力先のディレクトリパスを指定します。

project-dirには、プロジェクトのディレクトリパスを指定します。

その他

appledocはXCodeのドキュメントセットに結果を出力することも可能です。
XCodeのドキュメントセットに出力すると、XCode上から参照可能になります。
詳細は上記参考サイトをご覧ください。

あとpdf出力はできないっぽいですね。

できたらサイコーなんですが。。

それではまた！