在 C 中使用 Doxygen 记录变量

Code:

#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 and iThree尽管那是我的意图。我该如何解决？

DOxygen 是为了记录类和函数头，或者换句话说，界面。将文档视为其他程序员为了正确使用您的类和函数而研究的东西。您不应该使用 DOxygen 来记录您的实现。相反，请在源代码中记录局部变量// or /* */.

在 DOxygen 中进行注释的方法有很多种，其中的一些示例（对于成员变量）可以在手册中看到here http://www.doxygen.nl/manual/docblocks.html。我已将它们复制到下面。

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