Comet はコメントブロックを自動挿入するユーティリティツールです。
- Why to use
開発者はしばしば自分の書いたコードのドキュメント提供を求められます。
とても便利なソースコードをドキュメント化するための自動生成ツールが存在しますが、その準備をするために多くの時間がかかります。
大きなプロジェクトには多くのクラスやカテゴリ、プロパティ、メソッドが定義されています。
プロジェクトのドキュメントを生成する下準備としてそれらすべてにコメントを付加する必要があります。この作業だけでもかなりの時間を要してしまいます。
その面倒な作業の一端をComet が請け負います。コメント内容自体を書くことはできませんが、必要な場所にappledoc用にフォーマットされたコメントブロックを追加する作業を肩代わりしてくれるので記述漏れを未然に防ぐことができます。
- Detail
クラスやカテゴリ、プロトコル、すべてのメソッド(*1)に対してappledoc 用にフォーマットされたコメントブロックを自動挿入してくれるので、ユーザは要素の内容・引数の内容・返り値の内容をコメントするだけでよくなります。 引数名も自動検出されます。
