objective-c - Objective-Cでは、どのユーティリティがコメントで@briefタグを使用しますか？

Question

私はObjective-Cでプログラミングを始めたばかりで、次のようなコメントの例を見つけました。

/*!
@brief The UIImageView we use to display the image generated from the imageBuffer
*/

目的は@brief何ですか？これはDoxygenのようなドキュメンテーションシステムに関連するものですか？

Answer 1

はい。これは、簡単な説明のためのコマンドを使用した、doxygenの関数記述の標準形式です。@brief

おそらくあなたはその表現に精通しているかもしれませんが\brief、それ@briefも許されています。マニュアルのこのセクションで説明されているすべてのバリエーションがあります。

コマンド@briefを入力すると、doxygenドキュメントを生成するときに、関数の簡単な説明が生成されます。その短い説明は、必要に応じて拡張できます。

Answer 2

また、このタグを使用すると、Xcodeのクイックヘルプにコメントを表示できます。

ほぼ完全なパターンは次のとおりです。

/**
 @brief Example usage:
 @code
 @endcode
 @param param
 */

Answer 3

はい、これは確かにdoxygenタグです。