Xcodeでインスタンス変数とメソッドのドキュメントを作成するには？

Question

Alt-Click私は作成したプログラムの一部としてインスタンス変数（またはメソッド）を作成し、それが目的であることを読み取ることができます。

Xcodeがクラス変数が私に宣言されているという事実は素晴らしいですが、十分ではありません。この場合、私はassetが本当に何であるかを記述するためにタイプされたカスタムテキストを見たいと思います。さらに、ivarのタイプも知っておくと便利です。

どうすればいいですか？この場合、私は疑問に思う私はこの情報がEclipseがJavaDoc内容を示してどのように似てXcode、内側から見ることができるならば、私は特に不思議assets

によって正確に何を意味しました。

Answer 1

あなたはあなたのプロジェクトのためのマニュアルセットを作成し、Xcodeでそれをインストールする必要があります。 appledocがこれを手伝ってくれます。これは、あなたのヘッダーに特別にフォーマットされたコメントからアップルのスタイルでドキュメントを生成することができるコマンドラインツールです。また、実行スクリプト構築フェーズでビルドプロセスに統合して、ドキュメントが常に最新のものになるようにすることもできます。

小規模なプロジェクトの場合、通常はそれほどの労力はありません。ヘッダーファイルにコメントを追加し、Cmd-click（Ctrl + Cmd +左矢印を使用してそこにジャンプするだけです）から来た）。

Answer 2

Documentation SetsのAppleドキュメントとgenerating doc sets using Doxygenの記事をご覧ください。後者はXcode 3.xをベースにしているので、どのように関連性があるのか​​疑問ですが、それでもなお見ておくとよいでしょう。

Doxygenを使用することを決めた場合（HeaderDocのような選択肢はドキュメント化に使用できますが、ドキュメントセットを作成するまでは何が得られるのか分かりません）、主な点はあなたですGENERATE_DOCSET=YESをあなたのDoxyfile（またはあなたがそれを呼び出すことに決めたもの）に投げたいでしょう。その後、結果は~/Library/Developer/Shared/Documentation/DocSetsに投げられます（Doxygenのドキュメントによる）。私はこれがXcode 4.xで動作するかどうかはわかりませんが、それは一発の価値があります。

注：このほとんどは、Barry Warkのthis answerに基づいています。私はこれを調べるのに苦労しなかったので、彼の答えではないので、図クレジットがそこにある。