我刚刚开始使用 Objective-C 编程,发现了一些示例注释,如下所示:
/*!
@brief The UIImageView we use to display the image generated from the imageBuffer
*/
目的是什么@brief
?这与 Doxygen 这样的文档系统有关吗?
是的。那就是标准格式有关 doxygen 中的函数描述,请使用以下命令@brief
进行简要说明。
也许你对这个表达更熟悉\brief
, but @brief
也是允许的。
您拥有中解释的所有变体本节 http://www.doxygen.nl/manual/docblocks.html手册的内容。
放置命令@brief
当您生成 doxygen 文档时,将生成该函数的简短描述。如果您愿意,可以扩展该简短描述。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)