佐長 Blog: iOSアプリのドキュメント作成 - [開発]

Doxygen(http://www.stack.nl/~dimitri/doxygen/)のようにソースコードからドキュメントを作成するAppledocを使ってみた。

AppledocはApple標準のスタイルのドキュメントを生成してくれるツールだ。

? Appledocとは

Objective-Cのコードにjavadocのようなコメントを記載して、Appleスタイルのドキュメントを生成してくれるツールだ。
Appledoc自体はObjective-Cで書かれている。
生成したドキュメントはインデックス化され、標準のドキュメントと同様にXcodeと連携して参照利用が可能である。

最新バージョン：2.1 (build 858)
ライセンス：修正BSDライセンス
github：https://github.com/tomaz/appledoc
システム要件：Xcode4.5以上、OS X 10.7以上

※ 2013/1/19 現在

ダウンロード

githubからソースコードをダウンロードする。
https://github.com/tomaz/appledoc

Mac OS Lionには標準でgitが入っているのでターミナルを起動して確認

$ git --version
git version 1.7.10.2 (Apple Git-33)

ソースコードをダウンロードする

$ git clone git://github.com/tomaz/appledoc.git <ダウンロードパス>

インストール

ダウンロードしたソースに含まれるスクリプトを利用してインストールを行う

sudo sh install-appledoc.sh -b /usr/bin -t ~/Library/Application\ Support/appledoc
･･･
** BUILD SUCCEEDED **

Installing binary to /usr/bin
Copying templates to <ホームディレクトリ>/.appledoc

ホームディレクトリにappledocができるので動作の確認

バージョンの確認

$ appledoc --version
appledoc version: 2.1 (build 858)

ヘルプの確認

$ appledoc --help

これでインストールはひとまず完了。

ソースコードへコメントを記入

今回は確認用にXcodeで簡単なプロジェクトを作成した。（Sinle View Application）
プロジェクト名はAppledocTestとした。
ドキュメント作成用に「sampleMethod:param2:param3」メソッドを追加してコメントを記入。

メソッド名、パラメータ、クラスの説明を記入。

このソースコードをドキュメントに書き出してみる。

ドキュメントの生成

ドキュメント生成に必要なコマンドは以下。

appledoc
　--project-name <プロジェクト名>
　--project-company <会社名>
　--company-id <会社ID>
　--create-docset
　--output <出力パス>
<ソースコードパス>

出力パスには生成したドキュメントのパスが記載されたテキストがはき出される。

appledoc --project-name AppledocTest --project-company YABLOG --company-id net.sato.dev.appledoctest --create-docset --output /Users/sato/Desktop/AppledocTest/out /Users/sato/Desktop/AppledocTest/

appledoc version: 2.1 (build 858)

outputにしたパスに「docset-installed.txt」が生成される。
「docset-installed.txt」には生成結果と生成したドキュメントのパスが記載されている。

Xcodeの「Organizer - Documentation」から生成したドキュメントを確認