在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
 */