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 也是允许的。您拥有 this section 中解释的所有变体。手册。

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