我试图在 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 实体)。
所以问题是:是否可以在代码示例中包含多行注释，如何实现？
最佳答案
使用不同的评论风格。
代替你拥有的，使用:
/// \brief My Doxygen comment.
///
/// \code
/// myFunction() /* Some multi-line comment */
/// \endcode
///
/// 和/*! 一样，都是doxygen 部分。预处理器会将每一行视为单行注释。
关于c++ - 如何在 Doxygen 代码示例中插入多行注释，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/8497055/