10

次のような本文内コメントで文書化したいコードがいくつかあります。

/*! \file best.cpp
 *  \brief The best
 *
 *  I am the best
 */

/*! \fn void theBestFunction(int)
 * I'm the best blah blah blah
 */
void theBestFunction(int ever)
{
    doThings();
    /*!
     * Does some more things
     */
    doMoreThings();
    /*!
     * Checks that the things it does are the best
     */
    checkBest();
}

しかし、これを実行すると、またはコマンドが使用されdoxygenたかのように、内部ブロックがコードフラグメントにフォーマットされているようです (実際には使用されていません)。本文内のコメントを通常のテキストのように書式設定したいと思います。@code\code

誰もこれに遭遇したことがありますか？ありがとう。

4

1 に答える 1

9

私は問題を解決することができました。どういうわけか、Doxygen はこれらのブロックを互いにインデントされているものとして処理していたことが判明し、Markdown のインデント (StackOverflow のように) はコード ブロックを示しています (http://en.wikipedia.org/wiki/Markdown#Code) . Markdownをオフにして問題を修正しました。

今後この質問を読む人にとって、Markdown のサポートが引き続き必要な場合は、2 行目でコメント ブロックを開始しないように注意してください。すぐにコメントを開始してください。

私の最小限の例をこれに変更します：

/*! \fn void theBestFunction(int)
 * I'm the best blah blah blah
 */
void theBestFunction(int ever)
{
    doThings();
    /*! Does some more things
     */
    doMoreThings();
    /*! Checks that the things it does are the best
     */
    checkBest();
}

（空白行が最初にあるのではなく、すぐに本文内のコメントが始まることに注意してください）は問題を解決します。

于 2012-06-27T14:08:51.453 に答える