문서화 변수

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 주석의 의견을 열어야합니다.

하지만,이 일을 명확하게 할 수 있습니다

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

당신이 당신의 문서를 파괴하지 않고 변수의 이름을 변경할 수 있습니다이 방법을하고 있기 때문에 소스 코드를 읽을 필요가 다른 프로그래머에 또한 쉽게 변수의 설명은 파일의 다른 위치가 아니라 그 옆에 있습니다.

Answer 2

DOxygen은 클래스 및 기능 헤더를 문서화하기 위해 만들어졌으며, 다시 말하면 인터페이스입니다. 이 문서는 다른 프로그래머가 학급과 기능을 올바르게 사용하기 위해 연구하는 것으로 생각하십시오. 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