ドキュメント自動生成のappledocを試してみたよ

ドキュメント自動生成のappledocを試してみたよ

ドキュメントも綺麗なのをつくりたい!

appledocはXcodeのプロジェクトからクラスドキュメントを生成できるフレームワーク?です。Doxygenと似てるんじゃないかな。でも、Doxygenはちょっと面倒だし、なんかサイトも古くてちょっとしょぼいので、かっこいいappledocを試して見ることにしました!

ちょっと前に仕入れたappledocの情報を元に手元の環境に設定してみました。ただ開発するだけじゃなくてやっぱりドキュメントも綺麗に作りたいじゃない!

あと、コメントの書き方も統一化された一般的なもので行いたい。それにはやっぱりこういうフレームワークを利用するのが一番かなと!

設定について

基本的にはtomaz/appledoc – GithubのREADMEが一番良いと思います。更に少しわかりやすく日本語で解説しているappledocを使ってObjective-CソースをXcode Organizerで表示できるようにするを参考にセッティングを行いました。Macにインストールする方法はいくつかあるのですが、僕は下記の方法で行いました。

  1. git clone git://github.com/tomaz/appledoc.gitを実行してgithubからclone
  2. sudo sh install-appledoc.sh -t defaultを実行してMacにインストール

ドキュメントの生成

  1. appledoc -p プロジェクト名 -c 会社名 --keep-undocumented-objects --keep-undocumented-members ディレクトリで、ドキュメントの生成。

これでドキュメントが生成できます。ドキュメントは、/Users/<ユーザ名>/Library/Developer/Shared/Documentation/DocSets/に出来上ががります。Xcodeからも認識されます。

appledoc-xcode

Xcodeからみるとこんな感じです!

appledoc-d1

appledoc-d2.png

この状態でパッケージの内容を表示すると、Contents/Resources/Documents下にHTMLも生成されているようです。

appledoc-contents

コンパイル時に自動生成

appledocのドキュメント作成を自動で行うようにするを参考に、自動で生成されるようにしてみました。とりあえずあまりグローバルにファイルを置くと後で混乱しそうなので、僕は、プロジェクトディレクトリの直下にAppledocSettings.plistを置いてみました。

うは、自動生成もできた(><)

こんなに簡単に綺麗なドキュメントができちゃうなんて感動です。ちなみに普段使ってるドキュメントリーダーのDashでももちろん認識可能でした。

今後は少しずつコメントの記述方法に慣れて行きたいと思います!

参考リンク

Pocket
LINEで送る

You may also like...