☰

Xcode 5 で利用できる新しいドキュメント コマンドは何ですか? [closed] 質問する

tag-icon • tag-icon objective-c documentation comments doxygen xcode5
Xcode 5 で利用できる新しいドキュメント コマンドは何ですか? [closed] 質問する

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

どのコマンドがサポートされていて、どのコマンドがサポートされていないのでしょうか?
それらの使用法は doxygen と異なるのでしょうか?

ベストアンサー1

以下は、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 */あり///ます//!。
  • コマンドは@（ヘッダードキュメントスタイル）または\（ドキシゲンスタイル) プレフィックス。(つまり、@bと は\bどちらも同じことを行います。)
  • コマンドは通常、説明している項目の前に来ます。(つまり、プロパティを文書化しようとしている場合、コメントはテキストの前に来なければなりません。) コマンドは、、、、のように、@property同じ行の後に置くこともできます。/*!</**<//!<///<
  • ドキュメントを追加することができますクラス、関数、プロパティ、そして変数。
  • を除くすべてのコマンドは、有効なコマンドであることを示す濃い緑色のテキストで表示されます@returns。
  • ドキュメントの最新の変更が反映される前に、プロジェクトをビルドする (または Xcode を再起動する) 必要がある場合があります。

ドキュメントを参照する場所:

1. コードの完了時に、次の短いテキストが表示されます。

ここに画像の説明を入力してください

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

2. 識別子名をオプションキーを押しながらクリックする:

ここに画像の説明を入力してください

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

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

4. Doxygenの場合

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

その他の注意事項

Doxygenの一般的な紹介とObjective-Cコードのドキュメント化方法については、このページ良いリソースのようです。

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

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

以下は機能しません:

  • \n: は改行を生成しません。改行を作成する 1 つの方法は、その行に何もないことを確認することです。スペース文字が 1 つも含まれていないことを確認してください。
  • \example

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

  • \引用
  • \docbookのみ
  • \enddocbookonly
  • \end内部
  • \endrtfonly
  • \endsecreflist
  • 例外
  • \mscファイル
  • \refitem
  • \関連
  • \rtfのみ
  • \secreflist
  • \短い
  • \スニペット
  • \目次
  • \vhdlflow
  • \~
  • \"
  • 。
  • ::
  • \|

Apple が予約したキーワード:

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

以下に、それらのキーワードの一部を示します。

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

最良の場合、キーワードによって説明フ​​ィールドに新しい行が作成されます(例: @discussion)。最悪の場合、キーワードとそれに続くテキストはクイック ヘルプに表示されません(例: @class)。

おすすめ記事