6

Xcode 5 がメソッド ドキュメントを自動的に解析するようになったことに気付きました。例えば：

/**
 Fetches a conversation with user.

 @param user The other user in the conversation.

 @return A conversation
 */
+ (Conversation *)conversationWithUser:(User *)user;

複数のトークンをサポートしています@(それらを呼び出す方法がわかりません)。例えば：

  • @warning
  • @note

ただし、太字のテキスト、イタリック体、またはリンクを追加できる方法や、これがどのような形式であるかはまだわかりません。

これがどのドキュメント形式か知っている人はいますか?

4

3 に答える 3

0

XCode 5 の新機能によると (ドキュメントの下):

フレームワーク API リファレンス ドキュメントのプロジェクト ドキュメントと独自のソース コード内の構造化コメントは、クイック ヘルプ パネルとコード補完ポップオーバー ビューに表示されます。Doxygen および HeaderDoc 構造化コメントがサポートされている形式です。

Header Doc ユーザー ガイドを確認できます。

どうやら、これらの機能のサブセットを使用しており、それらの多くは機能しません。

于 2013-09-27T19:39:01.183 に答える
0

完全ではありません。現時点では、すべての doxygen タグをサポートしているわけではありません。基本的なサブセットのみです。

-Wdocumentationそれまでの間、 and -Wdocumentation-unknown-command(または、start withと reduce) のようなフラグを使用できます-Weverything。clang は、認識されていないものや不正な形式のものに遭遇した場合に通知します。利用可能なタグの完全なリストが必要な場合は、トランクを確認してください。

于 2013-09-27T20:01:40.600 に答える