AppleDocについて（その１）

開発のプロセスについて

開発を進める際には次のようなプロセスを踏むかと思います。

• 仕様を決定
• 仕様書を書く
• 設計を考える
• 設計書を書く
• ソースコードを書く
• デバッグする
• 開発終了

また、開発終了後やデバッグ後にソースコードが変わり設計書を変えなければいけないこともあります。ソースコードが変わる毎に設計書を書き直すのはなかなかしんどい作業です。ソースコードが設計書だという人もいますが、ソースコードの隅から隅まで読んでいくのも手がかかる作業です。 そうやっていくうちに設計書がないパターンもあるかと思いますが、やはりソースコードと整合している仕様書があると開発が楽になります。 そのような時にソースコード中にコメントとして書いたものをドキュメントにするやり方があり、XCodeの環境では”AppleDoc”というモノが使えます。Javaで言う、”Javadoc”みたいなものです。

そのAppleDocについて簡単に説明したいと思います。

AppleDocとは

AppleDocとはObjective-Cのソースより、AppleのAPIドキュメントのようなドキュメントを作成するツールです。AppleDocの目指すところとしては次のような事があります。

• 人間的に読みやすいソースコードコメントであること。
• 簡単にオブジェクトとメンバの相互の参照をする。
• AppleのソースコードHTMLドキュメントのようなものを生成すること。
• インデクッス化され、ブラウザ可能なXcodeドキュメントセットを生成、インストールすること。
• ドキュメントにソースコードから生成するシングルツールであること。
• 簡単にカスタマイズ可能なアウトプット。
• 簡単にデバッグするために100%のObjective-Cを管理。

AppleDocのビルドインストール

このAppleDocですがバイナリでは提供されていませんので、ソースを取得してビルドする必要があります。Githubよりソースを取得することができます。

https://github.com/tomaz/appledoc

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

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

インストールが成功すると次の表示がされます。

** INSTALL SUCCEEDED **
Installing binary to /usr/bin
Copying templates to /Users/[ユーザ名]/Library/Application Support/appledoc

バージョンを確認してみると。

appledoc --version
appledoc version: 2.2 (build 963)

ひとまず、今回はインストールまでとします。

参照

http://dev.classmethod.jp/smartphone/iphone/ios-appledoc-1/

http://qiita.com/mtgto/items/c97c59d93fe67d748055

詳解 Objective-C 2.0 第3版

上を目指すプログラマーのためのiPhoneアプリ開発テクニック iOS 7編