Apple社純正風のドキュメントが簡単に作れる「appledoc」について紹介します。

みなさん、こんにちは。
アイリッジ開発チーム iOSアプリ開発担当です。

今回の記事では、Objective-Cのソースのドキュメント化について書きます。

開発の現場では、納期に追われて、ソースコードのドキュメント化はあまり行われていないかもしれません。

プログラマによっては、1週間前に書いたコードですら、内容を覚えていなかったりします(笑)ので、やはりドキュメントがあった方が、必要なタイミングですぐに記憶を呼び戻すことができ、心強いですよね。

そこで、Apple社純正風のドキュメントが簡単に作れる「appledoc」を紹介します。 http://gentlebytes.com/appledoc/

手順

1. 環境構築

Macのターミナルで以下コマンドをたたき、GitHubからappledocのソースをダウンロードします。

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

クローンしたappledoc内にあるシェルスクリプト install-appledoc.sh を実行し、
インストールします。コマンドは以下になります。

sh install-appledoc.sh 

2. ソースの下準備

ソースコードのヘッダファイルにおいて、宣言しているクラスやプロパティ、メソッドの直前に以下のようなコメントを入れます。

/**  
 コメント  
 */

記述ルールの詳細については、以下URLをご参照ください。
https://github.com/tomaz/appledoc/wiki/appledoc-docs-comments

3. ドキュメント化を実行

次に、ターミナル上で、ドキュメント化したいソースのアプリプロジェクトのある場所(.xcodeprojファイルが存在する場所)にcdします。
そして、以下のコマンドをたたくと、HTMLが生成され、ドキュメント化されます。

appledoc --project-name プロジェクト名 --project-company 自分の会社名 --create-html --no-create-docset --output HTMLを生成したいディレクトリ ソースコードが存在する場所

なお、このコマンドは長いため、シェルスクリプト化しておくとよいかもしれません。

4. 生成されたドキュメント(HTML)

Appleっぽくてクールですね。読みやすいです。

20150310

仲間募集中

アイリッジでは、開発作業を効率的に進める方法など、楽しく情報交換しながら働ける仲間を募集しています。詳しくは募集要項へ!

URL: https://iridge.jp/recruit/


本記事はアイリッジブログで公開していたものをエンジニアリングブログとして再構成したものとなります。記事の内容は、記事執筆当時のものと異なる可能性があります。