Objective-Cメソッドの説明（doc comments）

Question

私は現在Objective-Cを学んでおり、メソッドの記述方法を知る必要があります。 Objective-Cでこれを行う方法を学ぶのが難しいです。 Javeで

私たちは、私が説明を置かないObjective-Cでこの

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

} 

がありますか？これはヘッダーファイルまたは実装ファイルにもありますか？

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

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

Answer 1

更新：Objcの場合、次の形式が使用できます。スウィフトコードを文書化する場合は、NSHipster's blog about Swift Documentation

を参照してください。XCode 5は、あなたが望むことができます。これが完了すると

/** 
* 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 +メソッド名、および...ほらをクリックすることができます：ファイルの.h でWonil Kimのおかげで、！もちろん

、あなたがKim's blog上で見ることができるように、これが唯一の方法ではありません。

また

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

、

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

あなたはポイントを持って...

多くとして、 Objective-Cはあなたのドキュメントを表示していません。実際にはどちらもjava（javadoc、may be）ではありません。あなたのIDE、この場合、クラッシュ不可能なXcodeです。

UPDATE2：Complete list of "Special Commands" in commentsです。

Update3と：あなたが///によるドキュメントの自動生成を有効にしたい場合はVVDocumenter-Xcodeを使用してください。

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

あなたはXcodeの8を使用している場合は、あなたのコードにドキュメンテーションに コメントを追加する（⌥オプション+⌘コマンド+ /）のショートカットを使用しますまたはそれ以上

Answer 2

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

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

Xcode 5（現在、OS XおよびiOSデベロッパープログラムの有料メンバーの開発者向けプレビューとして利用可能）は、独自のコードのドキュメンテーションコメントを表示します。 “Quick Help” on the Developer Tools Features pageを参照してください。ヘッダファイルにdocコメントを書き込む必要があります。 doxygenまたはheaderdoc形式を使用できます。

Answer 3

ここでは説明をどこに入れますか？

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