8

コード：

#include <stdio.h>

/*
 * \var int iOne
 * \brief Integer 1
 */
/*
 * \var int iTwo
 * \brief Integer 2
 */
/*
 * \var int iThree
 * \brief Integer 3
 */

/**
 * \brief Imitates a sheep.
 */
void sheep();

/**
 * \brief Main function for test code
 */
int main() {
    int iOne, iTwo, iThree;
    iOne = 1;
    iTwo = 2;
    iThree = 3;
    printf("%d %d %d", iOne, iTwo, iThree);

    return 0;
}

void sheep() {
    printf("Meeeh");
}

これは の説明を生成しませんがiOne、それが私の意図でした。これを修正するにはどうすればよいですか?iTwoiThree

4

2 に答える 2

20

DOxygen は、クラスと関数ヘッダー、つまりインターフェイスをドキュメント化するために作成されました。ドキュメントは、クラスや関数を適切に使用するために他のプログラマーが学習するものと考えてください。実装を文書化するために DOxygen を使用しないでください。代わりに、ソース内のローカル変数を//またはで文書化します/* */。

DOxygen でコメントを作成する方法はいくつかあります。その例 (メンバー変数の場合) は、こちらのマニュアルに記載されています。以下にコピーしました。

int var; /*!< Detailed description after the member */

int var; /**< Detailed description after the member */

int var; //!< Detailed description after the member
         //!< 

int var; ///< Detailed description after the member
         ///< 

int var; //!< Brief description after the member

int var; ///< Brief description after the member
于 2013-02-28T23:33:11.980 に答える
8

でコメントを Doxygen コメントとして開く必要があります/**。

ただし、これを行う方が明確な場合があります。

int main() {
   /** \brief Integer 1 */
   int iOne;
   /** \brief Integer 2 */
   int iTwo;
   /** \brief Integer 3 */
   int iThree;
   /** ... and so on ... */
}

このようにして、ドキュメントを壊さずに変数の名前を変更できます。また、変数の説明がファイル内の他の場所ではなく変数の隣にあるため、ソース コードを読む必要がある他のプログラマーにとっても簡単です。

于 2010-01-14T14:48:56.577 に答える