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

Question

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

例如：

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

我已经尝试了适用于JavaDoc注释的建议：使用HTML实体对斜杠进行编码，例如：

* \code
* myFunction() /* Some multi-line comment */
* \endcode

但是这并不起作用（我猜测是因为Doxygen在代码段中不会替换HTML实体）。

那么问题来了：是否可以在代码示例中包含多行注释，如何实现？

- Ignitor

Answer 1

使用不同的注释样式。

不要使用现有的方式，而应该使用：

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

///与/*!相同，标识doxygen代码块。预处理器会将每一行视为单行注释。

- littleadv