biến Lập tài liệu với Doxygen trong C

Question

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"); 
} 

này không tạo ra giới thiệu cho iOne, iTwo và iThree mặc dù đó là ý định của tôi. Làm thế nào để sửa lỗi này?

Answer 1

Bạn cần mở nhận xét của mình dưới dạng bình luận Doxygen với /**.

Nó có thể được rõ ràng hơn để làm điều này, mặc dù:

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

Bằng cách này bạn có thể thay đổi tên của biến mà không vi phạm tài liệu của bạn và nó cũng dễ dàng hơn trên các lập trình viên khác, những người cần phải đọc mã nguồn của bạn bởi vì mô tả của biến nằm bên cạnh nó, không phải ở đâu đó trong tệp.

Answer 2

DOxygen được tạo thành các lớp tài liệu và tiêu đề chức năng hoặc nói cách khác, giao diện . Hãy suy nghĩ về tài liệu như một cái gì đó mà các lập trình viên khác nghiên cứu để sử dụng các lớp và các chức năng của bạn đúng cách. Bạn không nên sử dụng DOxygen để ghi lại việc triển khai của bạn. Thay vào đó, hãy ghi lại các biến cục bộ của bạn trong nguồn với // hoặc /* */.

Có một số cách để đưa ra nhận xét trong DOxygen, một số ví dụ về (đối với biến thành viên) có thể được xem trong hướng dẫn sử dụng here. Tôi đã sao chép chúng bên dưới.

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