34

Xcode で自分のコードのクイック ヘルプ エントリを作成するにはどうすればよいですか? Java をコーディングするときの Eclipse 機能のようなコーディング サポートとしてそれが欲しいだけです。Eclipse では、メソッドを別の場所に移動すると、メソッドの上に入力したコメントが表示されます。

Xcode に相当するものは「クイック ヘルプ」のようです。

Doxygenを使用する以外に本当に方法はありませんか? Doxygen は、私が取り組んでいる小さなプロジェクトにはやり過ぎのようです。現時点では、クイック ヘルプを完全に入力するだけでよいことは確かです。そのため、「プロジェクトのドキュメントを作成する必要があります」などのヒントは避けてください。

このトピックで見つけたのはこの質問だけだったので、助けていただければ幸いです。

しかし、ご覧のとおり、解決策はありません。

4

7 に答える 7

9

唯一の方法は、コードのドキュメント セットを作成し、それを XCode にインストールすることだと思います。

Apple が「クイック ヘルプ」と呼んでいる Xcode 4 のコンテキスト ヘルプは、インストールされているドキュメント セットに完全に依存しています。Xcode 4 は、Mac OS および iOS API のドキュメント セット (アップデートを含む) を自動的にダウンロードしますが、サードパーティ セットもインストールできます。

(...)

ドキュメント セットを作成したら、それを Xcode の環境設定 ([ドキュメント] タブ) にインストールできます。ドキュメント セットが正しく構築およびインストールされていると仮定すると、クイック ヘルプは「問題なく機能する」はずです。もちろん、複雑な API をグループや広い世界と共有しない限り、これは限られた用途しかありません。

ソース: http://xcodebook.com/2011/04/providing-your-own-quick-help/

Apple のドキュメント セット ガイド: http://developer.apple.com/library/mac/documentation/DeveloperTools/Conceptual/Documentation_Sets/

于 2011-07-08T16:55:37.653 に答える
6

Xcode 5.0 では、変数とメソッドの Doxygen と HeaderDoc の書式設定が自動的に解析され、クイック ヘルプ ポップオーバーに表示されます。詳細についてはこちらをご覧ください。

/**
 * Add a data point to the data source.
 * (Removes the oldest data point if the data source contains kMaxDataPoints objects.)
 *
 * @param aDataPoint An instance of ABCDataPoint.
 * @return The oldest data point, if any.
 */
 - (ABCDataPoint *)addDataToDataSource:(ABCDataPoint *)aDataPoint;

Xcode では次のようにレンダリングされます。

プロパティに関しては、次のように簡単です。

/// Base64-encoded data.
@property (nonatomic, strong) NSData *data;

オプションを押しながらクリックすると、この素敵なポップオーバーが表示されます:

于 2013-10-08T20:49:26.417 に答える