objective-c - 用C中的Doxygen记录变量

代码:

#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的描述。我该如何解决？

最佳答案

您需要使用/**以Doxygen注释的形式打开注释。

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

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

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

关于objective-c - 用C中的Doxygen记录变量，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/2064871/

Brief

objective-c - 用C中的Doxygen记录变量