objective-c - 在 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 用于记录类和函数头，或者换句话说，接口(interface)。将文档视为其他程序员为了正确使用您的类和函数而学习的东西。您不应该使用 DOxygen 来记录您的实现。相反，使用 // 或 /* */ 在源代码中记录您的局部变量。

在 DOxygen 中有很多方法可以进行注释，其中一些示例(对于成员变量)可以在手册中看到 here .我已将它们复制到下面。

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