2014年5月23日金曜日

HeaderDoc がいい感じ

HeaderDocはソースコードのコメントに記述した引数や説明をから、クラスやメソッドのドキュメントを生成するコマンドラインツール。いつのまにか Xcodeとの統合がいい感じになってる件の紹介記事。


HeaderDoc形式でコメントを書式で書いておくとポップアップ(QuickHelp)に出るようになっている。

例えばこう書いておき、
/*!
 * @brief LKAssetsGroup collection
 */
@property (weak, nonatomic, readonly) NSArray* assetsGroups;
assetsGroupsの上でoption＋クリックするとこうなる

メソッド定義もこうなる

記事ではXcodeのスニペットを使うと手間が省けると紹介している。

その他 headerdoc2html を使った HTMLドキュメント生成などやVVDocumenter-Xcodeの活用など。


公式ドキュメント


時刻:

0 件のコメント:

コメントを投稿