2012-09-14 2 views
6

私はCocoaオブジェクトをタイプアップしてそのオブジェクトのセレクタを呼び出すときに、そのメソッドに関する 'ドキュメント'または 'ヘルプ'情報を表示することがあります。たとえば、[NSArray alloc]と入力すると、2つのヘルプヒントが表示されます。 1つはNSArray、1つはallocです。私はコードを入力すると、これらの両方がポップアップのオートコンプリート候補リストボックスに表示されます。Objective Cのメソッドをドキュメントで飾る方法は?

入力時に表示される同様のメソッド/クラス装飾ヘルプヒントを作成するにはどうすればよいですか?私は私のカスタムクラス名とカスタムメソッドを入力すると私のコメントを見たいと思います。これどうやってするの?

たとえば、C#では、メソッド、クラス、またはインターフェイス/プロトコル宣言の前に配置できるXMLドキュメントを使用してこの機能を提供しています。

+1

_ "カスタムクラス名とカスタムメソッドを入力するときにコメントを表示したい" _これは非常に便利です。 :) – Kjuly

答えて

7

"docset"を作成する必要があります。あなたのコメントからドキュメントセットを作成するためのツールがappledocのようにあります。コードにappledocを実行するビルドフェーズを設定することができます。

問題は、Xcode 4を再起動してXcodeを再起動する以外は、ドキュメントセットを再読み込みする方法がないことです。ビルドの一環として自動的にappledocを実行しても、Xcodeを再起動してdocsetの変更を確認する必要があります。

+0

+1 appledocフレームワークは、Xcodeのファーストクラスの市民であるドキュメントセットを作成するのに最適です。 – jlehr

+0

ええ;私が初めて自分のドキュメントをAppleのサイドと一緒に見たのは、私にとっては驚くべきことでした。私はそれについて準備ができているかどうかは確かではありませんでした....幸いにも、appledocもHTMLを生成します。 –

+0

ええ、これは残念な仕事のようですが、それは何よりも優れていると思います! – Brett

関連する問題