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

【问题标题】：How to insert multi-line comment in Doxygen code examples如何在 Doxygen 代码示例中插入多行注释
【发布时间】：2012-01-19 18:56:28
【问题描述】：

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

例如：

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

我已经尝试过适用于 JavaDoc cmets 的建议：使用 HTML 实体对斜线进行编码，如下所示：

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

但这不起作用（我猜是因为 Doxygen 不会替换代码部分中的 HTML 实体）。

所以问题是：是否可以在代码示例中包含多行 cmets 以及如何实现？

【问题讨论】：

【解决方案1】：

使用不同的评论风格。

代替你拥有的，使用：

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

/// 与 /*! 相同，并标记一个 doxygen 部分。预处理器会将每一行视为单行注释。

【讨论】：