24

私は現在、Objective-C を学んでおり、メソッドの説明の書き方を知る必要があります。Objective-Cでこれを行う方法を学ぶのは非常に困難です。

Javeにはこれがあります

/**
< h2 >MethodName</ h2 >
< p >Various Description, can use html with images etc.</ p >
*/
private void methodName(args[]..)
{

}

Objective-C では、説明をどこに配置すればよいですか? また、これはヘッダー ファイルまたは実装ファイルにありますか?

//Within Implementation?
- (float)gteHeightPercentage:(float)percentageToGet
{
    return self.view.bounds.size.height * percentageToGet;
}

//Within Header?
- (float)getWidthPercentage:(float)percentageToGet;
4

3 に答える 3

6

あなたが記述しているものは、「ドキュメント コメント」または略して「ドキュメント コメント」と呼ばれます。

バージョン 4.6.3 の Xcode では、ポップアップ ウィンドウまたはそのクイック ヘルプ インスペクタに独自のドキュメント コメントが表示されません。コメントを Xcode に表示させるには、コメントを「docset」にコンパイルする必要があります。それを行うためのツールはありますが、Xcode にドキュメントセットをリロードさせる方法は、いったん終了してから再起動する以外にないため、面倒なことはお勧めしません。

Xcode 5 (現在、OS X および iOS 開発者プログラムの有料メンバー向けの開発者プレビューとして利用可能)は、独自のコードのドキュメント コメントを表示します。開発者ツールの機能ページの「クイック ヘルプ」を参照してください。ドキュメント コメントはヘッダー ファイルに記述する必要があります。doxygen または headerdoc 形式のいずれかを使用できます。

于 2013-07-17T02:55:56.983 に答える
0

Objective-C では、説明をどこに配置すればよいですか?

gcc や llvm などの Objective-C コンパイラは、コードをどのように文書化するかを気にしません。DoxygenやHeaderDocなど、適切にフォーマットされたコメント (通常はヘッダー ファイル内) からドキュメントを作成できるドキュメント ジェネレーターがいくつかあります。さらに、Xcode を使用すると、コードで定義されているシンボルの定義に簡単にジャンプできます。また、「クイック ヘルプ」インスペクターは、コードに特別な注釈を付けなくても、定義を表示できます。

于 2013-07-17T02:55:57.853 に答える