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也是允许的。您已在手册的本节中解释了所有变体。

当您生成 doxygen 文档时，输入该命令@brief将生成函数的简短描述。如果您愿意，可以扩展该简短描述。

Answer 2

此标签还使您能够在 Xcode 的快速帮助中显示您的评论。

几乎完整的模式是：

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

Answer 3

是的，这确实是一个 doxygen 标签。