web-dev-qa-db-ja.com

Objective-Cメソッドの説明（ドキュメントコメント）

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

ジェイブにはこれがあります

/**
< 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;
objective-cxcodedocumentationcomments
22
Oliver Dixon

Update：以下のフォーマットはObjcで機能します。 Swiftコードを文書化する場合は、 NSHipsterのSwift Documentation

XCode 5はあなたが望むことをすることができます。 。hファイルの Wonil Kim に感謝します。

/** 
 * Add new message between source to destination timeline as empty name string
 * @author Wonil Kim
 *
 * @param sourceId Source timeline entity ID
 * @param destId Destination timeline entity ID
 * @return A newly created message instance
 */
- (ISMessage*)messageFromTimeline:(NSInteger)sourceId toTimeline:(NSInteger)destId;

これが完了すると、次のことができます alt+メソッド名をクリックして、..voilà！

もちろん、 Kimのブログ で確認できるように、これが唯一の方法ではありません。

/*! Some description of the method....
 * \returns  The result
 */

または、

/// Some description to show up, done by:
/// @author  Olly Dixon

あなたはポイントを得ました...

多くの人がすでに述べたように、Objective-Cはドキュメントを表示しません。実際、どちらもJava（javadoc、かもしれません）ではありません。それはあなたのIDE、この場合、クラッシュできないXcodeです:)

UPDATE2：comments の「特殊コマンド」の完全なリスト。

UPDATE3：///によるドキュメントの自動生成を有効にする場合は、 VVDocumenter-Xcode を使用します。

UPDATE4：：VVDocumenterがXcodeに統合されました：

Xcode 8以降を使用している場合は、ショートカット（⌥Option +⌘Command + /）を使用して、ドキュメントコメントをコードに追加します。

64
Q8i

あなたが説明しているものは「ドキュメンテーションコメント」または略して「ドキュメントコメント」と呼ばれます。

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

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

5
rob mayoff

Objective-Cでは、どこに説明を配置しますか？

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

0
Caleb