195

Xcode 5 の新機能の1 つは、独自のコードを特別なコメント構文で文書化する機能です。形式は doxygen に似ていますが、これらの機能のサブセットのみをサポートしているようです。

サポートされているコマンドとサポートされていないコマンドは?
それらの使用法のいずれかが doxygen と異なりますか?

4

4 に答える 4

426

これは、Xcode 5.0.2 の時点で私が見つけたすべてのオプションの例です。

ここに画像の説明を入力

これは、次のコードで生成されました。

/** First line text.

 Putting \\n doesn't create a new line.\n One way to create a newline is by making sure nothing is on that line. Not even a single space character!

 @a Italic text @em with @@a or @@em.

 @b Bold text with @@b.

 @p Typewritter font @c with @@p or @@c.

 Backslashes and must be escaped: C:\\foo.

 And so do @@ signs: user@@example.com

 Some more text.
 @brief brief text
 @attention attention text
 @author author text
 @bug bug text
 @copyright copyright text
 @date date text
 @invariant invariant text
 @note note text
 @post post text
 @pre pre text
 @remarks remarks text
 @sa sa text
 @see see text
 @since since text
 @todo todo text
 @version version text
 @warning warning text

 @result result text
 @return return text
 @returns returns text


 @code
// code text
while (someCondition) {
    NSLog(@"Hello");
    doSomething();
}@endcode
 Last line text.

 @param param param text
 @tparam tparam tparam text
 */
- (void)myMethod {}

ノート：

  • コマンドは、/** block */、/*! block */、または で始まる必要があり///ます//!。
  • コマンドは@( headerdocスタイル) または\( doxygenスタイル) プレフィックスで動作します。(つまり@b、\bどちらも同じことを行います。)
  • コマンドは通常、説明している項目の前に来ます。(つまり、プロパティを文書化しようとしている場合は、コメントを@propertyテキストの前に置く必要があります。)コメントは、同じ行の後に、、、、を使用して/*!<配置/**<でき//!<ます///<。
  • クラス、関数、プロパティ、および変数にドキュメントを追加できます。
  • これらのコマンドはすべて濃い緑色のテキストで表示され、有効なコマンドであることを示します@returns。
  • ドキュメントへの最新の変更が表示される前に、プロジェクトをビルドする (または Xcode を再起動する) 必要がある場合があります。

ドキュメントの参照先:

1. コードの完成中に、簡単なテキストが表示されます。

ここに画像の説明を入力

これにより、簡単なテキストが表示されます (書式なし)。短いテキストが存在しない場合は、最初の @block までのすべてのテキストを連結して表示します。存在しない場合 (たとえば、@return で開始)、すべての @command をストライプ化してすべてのテキストを連結します。

2. 識別子名を Option-クリック:

ここに画像の説明を入力

3. クイック ヘルプ インスペクター パネルで

(最初のスクリーンショットを参照してください。)

4.Doxygenで

Xcode 5 のコマンドは Doxygen と互換性があるため、Doxygen をダウンロードして使用すると、ドキュメント ファイルを生成できます。

その他の注意事項

Doxygen の概要と Objective-C コードのドキュメント化方法については、このページが適切なリソースのようです。

サポートされているコマンドの一部の説明:

  • @brief: 説明フィールドの先頭にテキストを挿入し、コード補完中に表示される唯一のテキストです。

以下は機能しません。

  • \n: 改行を生成しません。改行を作成する 1 つの方法は、その行に何もないことを確認することです。スペース文字一つもありません！
  • \example

以下はサポートされていません (濃い緑色でも表示されません)。

  • \cite
  • \docbookonly
  • \enddocbookonly
  • \end内部
  • \endrtfonly
  • \endsecreflist
  • \idlexcept
  • \mscファイル
  • \reitem
  • \関連も
  • \rtfのみ
  • \secreflist
  • \短い
  • \スニペット
  • \目次
  • \vhdlflow
  • \~
  • \"
  • .
  • ::
  • \|

Apple 予約キーワード:

Apple は、ドキュメントでのみ機能する予約済みのキーワードと思われるものを使用しています。濃い緑色に見えますが、Apple のようには使えないようです。AVCaptureOutput.h などのファイルで、Apple の使用例を確認できます。

これらのキーワードの一部を次に示します。

  • @abstract、@availibility、@class、@discussion、@deprecated、@method、@property、@protocol、@related、@ref。

せいぜい、キーワードによって [説明] フィールドに新しい行が表示される程度です (例: @discussion)。最悪の場合、キーワードとそれに続くテキストがクイック ヘルプに表示されません (@class など)。

于 2013-10-03T21:08:14.707 に答える