質問

の1つです。 Xcode 5の新機能 は、特別なコメント構文で自分のコードを文書化する機能です。このフォーマットはdoxygenに似ていますが、以下のサブセットしかサポートしていないようです。 その特徴 .

どのコマンドに対応し、どのコマンドに対応していないのか？

doxygenと使い方が違うところはありますか？

どのように解決するのですか？

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. 識別子名をOptionクリックする。

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

(最初のスクリーンショットを参照)

4. ドキシジェンでは

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

その他の注意事項

Doxygenの一般的な紹介と、Objective-Cコードの文書化の方法について説明します。 このページ が良い資料のようです。

対応するいくつかのコマンドの説明。

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

以下は動作しません。

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

以下はサポート対象外です（濃い緑色で表示もされません）。

• \୧⃛(๑⃙⃘◡̈๑⃙⃘)
• \♪Docbookonly
• \୧⃛(๑⃙⃘◡̈๑⃙⃘)
• \୧⃛(๑⃙⃘◡̈︎๑⃙⃘)
• \୧⃛(๑⃙⃘◡̈๑⃙⃘)
• \୧⃛(๑⃙⃘◡̈๑⃙⃘)
• \アルバム
• \．
• \アルバム
• \୧⃛(๑⃙⃘◡̈๑⃙⃘)
• \ʕ-̫͡-ʔ
• \୧⃛(๑⃙⃘◡̈๑⃙⃘)
• \Ȃショート
• \୧⃛(๑⃙⃘◡̈๑⃙⃘)
• \♪テーブルオブコンテンツ
• \Ъvhdlflow
• \~
• \୧⃛(๑⃙⃘◡̈๑⃙⃘)
• .
• ::
• \|

Appleの予約キーワードです。

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

以下に、そのキーワードの一部を紹介します。

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

よくても、キーワードはDescriptionフィールドに改行されます(例: @discussion)。最悪の場合、そのキーワードとそれに続くテキストはクイックヘルプに表示されなくなります (例: @class)。