Gewusst wie: einfügen von multi-line-Kommentar in Doxygen code-Beispiele

Ich versuche gehören ein code-Beispiel enthält einen mehrzeiligen Kommentar in der Doxygen-Dokumentation. Das problem ist, dass der C++ - Präprozessor interpretiert die */ als das Ende meiner Doxygen-Kommentar und daher ist die syntax der Datei ist kaputt.

Beispiel:

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

Ich habe bereits versucht, den Vorschlag, die Werke für JavaDoc-Kommentare: Kodierung der Schrägstrich mit HTML-entities wie diese:

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

aber das funktioniert nicht (ich denke, da Doxygen nicht ersetzen HTML-entities innerhalb von code-Abschnitten).

Die Frage ist also: ist es möglich, auch multi-line-Kommentare im code-Beispiel, und wie kann es gemacht werden?

InformationsquelleAutor Ignitor | 2011-12-13

c++comments doxygen

8

Verwenden verschiedene Kommentar-Stile.

Anstelle von dem, was Sie haben, verwenden Sie:
```
///\brief My Doxygen comment.
///
///\code
///myFunction() /* Some multi-line comment */
///\endcode
///
```
Den /// ist das gleiche wie /*! und markiert eine doxygen-Teil. Der pre-Prozessor zu behandeln, wird jede Zeile als eine einzige Zeile Kommentar.

InformationsquelleAutor littleadv

Schreibe einen Kommentar

Du musst angemeldet sein, um einen Kommentar abzugeben.