CLion : 자동 삽입되는 Doxygen 주석 템플릿 설정하기

본 글에서는 JetBrains 사의 C/C++ 개발용 IDE인 CLion 에서, 자동 삽입되는 Doxygen 주석의 템플릿 내용을 설정하는 방법을 설명한다.

 

본 글의 내용을 작성하는데 사용된 환경은 다음과 같다.

 

• 윈도우즈 10 프로
• CLion 2019.3.1

 

기본 삽입 문구

CLion은 C/C++ 형식 Doxygen 주석의 시작 문자("/**", "///")를 입력하면, Doxygen 주석 템플릿을 자동으로 삽입해 주는 기능을 기본 제공한다.

 

예를 들어 다음과 같이 sum1() 이라는 함수를 정의한 다음, 해당 함수의 윗 라인에서 "/**" 입력 후 엔터를 입력하면, 아래 라인의 코드가 함수 정의문이라는 것을 파악하여, 함수에 관련된 Doxygen 주석 템플릿을 자동으로 삽입해 준다.

/**
 * @param a
 * @param b
 * return
 */
int sum1(int a, int b)
{ 
  return a + b;
}

Doxygen 주석 템플릿 자동 생성

 

이처럼 자동으로 삽입되는 Doxygen 주석 템플릿의 내용을 설정을 통해 일부 변경할 수 있다.

예를 들어, Doxygen 주석에 @brief 태그를 넣어서 작성하는 코딩 규칙을 따를 경우, @brief 문구도 자동으로 추가되도록 설정할 수 있다.

 

 

자동 삽입되는 Doxygen 주석 템플릿 변경하기

다음과 같은 방법을 통해 자동 삽입되는 Doxygen 주석 템플릿을 변경할 수 있다.

 

메뉴바에서 "File" → "Settings" 메뉴를 선택하여 "Settings" 창을 띄운다. "Settings" 창의 좌측 메뉴에서 "Editor" → "Code Style" → "C/C++" 메뉴를 선택하면, 화면 하단에 Doxygen 주석에 관련된 설정 항목들이 3가지 존재한다.

C/C++ 코드용 Doxygen 주석 템플릿 설정 화면

 

현재 설정할 수 있는 항목은 다음과 같다.

 

• Add @brief tag : Doxygen 주석 템플릿을 자동 삽입할 때, @brief 태그도 함께 삽입하도록 설정할 수 있다. 기본적으로 비활성화 되어 있다. 합의된 코딩 스타일 및 규칙에 따라 설정하면 된다.
• Tag prefix in line comments : 라인형 주석 문자인 "///" 를 입력하면 생성되는 태그의 유형을 설정한다. 기본적으로는 \param 과 같이 \ 로 설정되어 있으며, 필요 시 @ 로 변경할 수 있다. 합의된 코딩 스타일 및 규칙에 따라 설정하면 된다.
• Tag prefix in block comments : 블록형 주석 문자인 "/**" 를 입력하면 생성되는 태그의 유형을 설정한다. 기본적으로는 @param 과 같이 @ 로 설정되어 있으며, 필요 시 \ 로 변경할 수 있다. 합의된 코딩 스타일 및 규칙에 따라 설정하면 된다.

 

 

@brief 태그를 함께 삽입하도록 하기 위해 "Add @brief tag" 체크박스에 체크를 하고 "OK" 버튼을 클릭하여 적용한다.

Add @brief tag 체크

 

 

다음과 같이 sum2() 라는 함수를 작성 후, "/**" 입력 후 엔터를 입력하면, @brief 태그가 함께 삽입되는 것을 확인할 수 있다.

/**
 * @brief
 * @param a
 * @param b
 * @return
 */
int sum2(int a, int b)
{
  return a + b;
}

@brief 태그가 추가로 삽입됨

 

라인형 주석 문자인 "///"  입력 후 엔터를 입력하면, 다음과 같은 형태의 주석 템플릿이 삽입된다. "\" 태그가 적용된 것을 확인할 수 있다.

/// \brief
/// \param a
/// \param b
/// \return
int sum3(int a, int b)
{
  return a + b;
}

라인형 주석의 템플릿 (\ 형식 태그 적용)

 

 

"Settings" 창에서 "Tag prefix in line comments" 를 "@param" 태그로 변경하면, 다음과 같은 형태의 주석 템플릿이 삽입된다. "@" 태그가 적용된 것을 확인할 수 있다.

/// @brief
/// @param a
/// @param b
/// @return
int sum4(int a, int b)
{
  return a + b;
}

라인형 주석의 템플릿 (@ 형식 태그 적용)

 

더욱 많은 설정이나 변경이 안 되는 것은 아쉽긴 하지만, 이 3가지 설정항목을 통해 원하는 템플릿을 적용할 수 있다.

 

파트너스 활동을 통해 일정액의 수수료를 제공받을 수 있음