在 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 中有多种方法可以制作 cmets，其中一些示例（对于成员变量）可以在手册 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

Answer 2

您需要使用 /** 将您的 cmets 作为 Doxygen cmets 打开。

不过，这样做可能更清楚：

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

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