用C中的Doxygen记录变量

Question

码:

#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,iTwo并且iThree虽然这是我的本意.我该如何解决？

Answer 1

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

Answer 2

您需要以Doxygen评论打开您的评论/**.

但是,这可能更清楚:

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

这样,您可以在不破坏文档的情况下更改变量的名称,并且对于需要读取源代码的其他程序员来说也更容易,因为变量的描述位于其旁边,而不是文件中的其他位置.