2012-10-07ドキュメント自動生成のappledocを試してみたよドキュメントも綺麗なのをつくりたい!appledocはXcodeのプロジェクトからクラスドキュメントを生成できるフレームワーク?です。Doxygenと似てるんじゃないかな。Doxygenはちょっと面倒だし、なんかサイトも古くてちょっとしょぼいので、かっこいいappledocを試して見ることにしました!ちょっと前に仕入れたappledocの情報を元に手元の環境に設定してみました。開発するだけじゃなくてやっぱりドキュメントも綺麗に作りたいじゃない!あと、コメントの書き方も統一化された一般的なもので行いたい。GithubのREADMEが一番良いと思います。Organizerで表示できるようにするを参考にセッティングを行いました。Macにインストールする方法はいくつかあるのですが、僕は下記の方法で行いました。ディレクトリで、ドキュメントの生成。これでドキュメントが生成できます。ドキュメントは、/Users/<ユーザ名>/Library/Developer/Shared/Documentation/DocSets/に出来上ががります。Xcodeからも認識されます。Xcodeからみるとこんな感じです!この状態でパッケージの内容を表示すると、Contents/Resources/Documents下にHTMLも生成されているようです。コンパイル時に自動生成appledocのドキュメント作成を自動で行うようにするを参考に、自動で生成されるようにしてみました。グローバルにファイルを置くと後で混乱しそうなので、僕は、プロジェクトディレクトリの直下にAppledocSettings.plistを置いてみました。うは、自動生成もできた(><)こんなに簡単に綺麗なドキュメントができちゃうなんて感動です。ちなみに普段使ってるドキュメントリーダーのDashでももちろん認識可能でした。コメントデータの処理方法の詳細はこちらをご覧ください。