在Objective-C中，什么实用程序在评论中使用@brief标记？

Question

我刚开始使用Objective-C进行编程，并找到了一些示例评论，如下所示：

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

@brief的目的是什么？这与Doxygen等文档系统有关吗？

Answer 1

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

Answer 2

是。这是doxygen中函数描述的标准格式，使用命令@brief进行简要说明。

也许您对表达式\brief更熟悉，但也允许使用@brief。 您可以在手册的this section中解释所有变体。

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

Answer 3

此标记还可让您在Xcode的快速帮助中显示评论。

几乎完整的模式是：

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