vscode: Doxygen Documentation Generator

 

/** 까지만 입력하면 brief, param 등의 항목들을 입력하는 칸이 자동으로 생성됩니다.

 

예를 들어 다음과 같은 함수가 정의 되어 있다고 해 봅니다. 

template <typename TYPE>
TYPE add(const TYPE &num1, const TYPE &num2) {
    return num1 + num2;
}

/***/
template <typename TYPE>
TYPE add(const TYPE &num1, const TYPE &num2) {
    return num1 + num2;
}

/**을 입력하면 뒤에 */이 자동으로 붙습니다. 

이후 엔터를 입력하게 되면 다음과 같이 기본적인 doxygen comment 부분이 자동으로 생성됩니다.

 

/**
* @brief
*
* @tparam TYPE
* @param num1
* @param num2
* @return TYPE
*/
template <typename TYPE>
TYPE add(const TYPE &num1, const TYPE &num2) {
    return num1 + num2;
}

 

이제 각 항목에 대해 적절한 설명을 기술합니다. 

 

 

Preference 부분에서 원하는 형태로 Doxygen 자동 생성에 대한 설정을 수행할 수 있습니다. 

 

 

Doxygen comment를 생성하는 trigger comment를 설정할 수도 있습니다.