如何在Doxygen代码示例中插入多行注释

Question

我试图在Doxygen文档中包含一个包含多行注释的代码示例.问题是C++预处理器将其解释*/为我的Doxygen注释的结尾,因此文件的语法被破坏了.

例如:

/*! \brief My Doxygen comment.
 *
 * \code
 * myFunction() /* Some multi-line comment */
 * \endcode
 */

我已经尝试过适用于JavaDoc注释的建议:使用HTML实体对斜杠进行编码,如下所示:

* \code
* myFunction() /* Some multi-line comment *&#47;
* \endcode

但这不起作用(我猜因为Doxygen不会替换代码部分中的HTML实体).

所以问题是:是否可以在代码示例中包含多行注释,如何才能完成？

Answer 1

使用不同的评论样式.

而不是你拥有的,使用:

/// \brief My Doxygen comment.
/// 
/// \code
/// myFunction() /* Some multi-line comment */
/// \endcode
///

的///是相同的/*!,并标志着一个doxygen的部分.预处理器将每行视为单行注释.