Как вставить многострочный комментарий в примеры кода 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 внутри разделов кода).

Таким образом, вопрос: возможно ли включить многострочные комментарии в пример кода и как это можно сделать?

Answer 1

Используйте разные стили комментариев.

Вместо того, что у вас есть, используйте:

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

/// совпадает с /*! и обозначает часть кислорода.Препроцессор будет обрабатывать каждую строку как однострочный комментарий.