現在、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;
ベストアンサー1
アップデート: 以下の形式は で使えますObjc。Swiftコードを文書化したい場合は、NSHipster の Swift ドキュメントに関するブログ
Xcode 5なら、あなたが望むことはすべてできます。キム・ウォンイル、 の中に.hファイル：
/**
* 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メソッド名を + クリックすると、出来上がりです!
もちろん、ご覧のとおりキムのブログただし、これが唯一の方法ではありません。
/*! Some description of the method....
* \returns The result
*/
あるいは、
/// Some description to show up, done by:
/// @author Olly Dixon
要点は分かりましたね...
すでに多くの人が言及しているように、Objective-C ではドキュメントが表示されません。実際、Java でも (おそらく javadoc ) 表示されません。これは IDE、つまりクラッシュしない Xcode です :)
更新2: コメント内の「特殊コマンド」の完全なリスト。
更新3:使用VVDocumenter-Xcodeによるドキュメントの自動生成を有効にしたい場合///。
更新4:: VVDocumenter が Xcode に統合されました:
Xcode 8以降を使用している場合は、ショートカット（⌥ Option + ⌘ Command + /）を使用してコードにドキュメントコメントを追加します。