Looking for doxygen Answers? Try Ask4KnowledgeBase
Looking for doxygen Keywords? Try Ask4Keywords

doxygendoxygen 시작하기


비고

이 섹션은 doxygen이 무엇인지, 왜 개발자가 그것을 사용하고 싶어하는지에 대한 개요를 제공한다.

또한 doxygen 내의 큰 주제를 언급하고 관련 주제에 링크해야합니다. doxygen에 대한 문서는 새로운 것이므로 관련 주제의 초기 버전을 만들어야 할 수도 있습니다.

코드 주석 달기

주석 블록을 자세한 설명으로 표시하는 방법은 여러 가지가 있으므로이 주석 블록은 Doxygen에 의해 구문 분석되고 다음 코드 항목에 대한 설명으로 설명서에 추가됩니다. 가장 일반적인 첫 번째 주석은 주석 시작 순서에 별표가있는 C 스타일 주석입니다 (예 :

/**
 * … text …
 */
int dummy_var;
 

다음 대안은 Qt 스타일을 사용하고 C 스타일 주석 블록의 여는 순서 다음에 느낌표 (!)를 추가하는 것입니다.

/*!
 * … text …
 */
void foo(void);
 

세 번째 방법은 두 줄 이상의 C ++ 주석 줄을 사용하는 것입니다. 각 줄은 추가 슬래시 또는 느낌표로 시작합니다.

/// 
/// ... text ... 
///
 

또는

//! 
//! ... text ... 
//!
 

어떤 사람들은 그들의 주석 블록이 문서에서 더 잘 보이도록하고 싶어합니다. 이를 위해 다음을 사용할 수 있습니다.

 /********************************************//** 
  * ... text 
  ***********************************************/
 

일반 주석 블록을 끝내고 특수 주석 블록을 시작하려면 2 개의 슬래시에 유의하십시오.

/////////////////////////////////////////////////
/// ... text ...
/////////////////////////////////////////////////
 

생성 된 문서를 구조화하고 작성하기 위해 Doxygen은 많은 수의 (> 170) 특수 명령을 제공합니다. 문서의 모든 명령은 백 슬래시 () 또는 at 기호 (@)로 시작합니다.

예를 들어

/**
 * \brief    A brief description in one short sentence.
 */
 

~에 해당합니다.

/**
 * @brief    A brief description in one short sentence.
 */
 

간단한 설명을 위해 몇 가지 가능성이 있습니다.

\brief 명령을 위의 주석 블록 중 하나와 함께 사용할 수 있습니다. 이 명령은 단락의 끝에서 끝나기 때문에 빈 줄 다음에 자세한 설명이 나옵니다.

/** \brief Brief description. 
 * Brief description continued. 
 * 
 * Detailed description starts here. 
 */ 
 

구성 파일에서 JAVADOC_AUTOBRIEFYES 로 설정된 경우 JavaDoc 스타일 주석 블록을 사용하면 첫 번째 점에서 끝나는 간단한 설명이 자동으로 시작되고 그 뒤에 공백이나 새 행 JAVADOC_AUTOBRIEF .

/// Brief description which ends at this dot. Details follow 
/// here. 
 

마지막으로 여기에 doxygen 함수의 전체 문서를위한 예제가 있습니다.

/**
 * \brief   The function bar. 
 *
 * \details This function does something which is doing nothing. So this text
 *          is totally senseless and you really do not need to read this,
 *          because this text is basically saying nothing.
 *
 * \note    This text shall only show you, how such a \"note\" section
 *          is looking. There is nothing which really needs your notice,
 *          so you do not really need to read this section.
 *
 * \param[in]     a    Description of parameter a.
 * \param[out]    b    Description of the parameter b.
 * \param[in,out] c    Description of the parameter c.
 *
 * \return        The error return code of the function.
 *
 * \retval        ERR_SUCCESS    The function is successfully executed
 * \retval        ERR_FAILURE    An error occurred
 */

errcode_t bar(int a, int b, int c)
{    
    /** More detailed description inside the code */
}
 

소스 및 Doxygen 홈페이지 에 대한 자세한 정보

설치 또는 설정

doxygen 설정 또는 설치에 대한 자세한 지침.