Visual studio code 확장 기능 : Doxygen 주석 자동 생성기

본 글에서는 Visual stuido code에서 작성되는 소스파일 내에 Doxygen 형식 주석을 자동 생성해 주는 기능을 적용하는 방법에 대해 설명한다.

 

Doxygen이란, 사전에 정의된 형식에 맞춰 주석을 작성하면, 해당 주석의 내용을 기반으로 매뉴얼을 자동 생성해 주는 툴이다. 최근 자동화된 개발 환경의 적용과 더불어 문서 관리 자동화를 위해 많이 적용되고 있다.

 

Doxygen에 관련된 내용은 아래 글을 참고한다.

2020/01/20 - [소프트웨어 개발 및 프로젝트 관리/문서화] - Doxygen : 소프트웨어 소스코드 문서 작성 자동화 - 소개

 

Visual studio code 용 Doxygen 주석 자동 생성기 설치하기

다음과 같은 절차에 따라 Doxygen 주석 자동 생성기 기능을 설치하여 적용할 수 있다.

 

1. 편집기 좌측의 마켓 플레이스 아이콘을 클릭하고, 검색 창에 "doxygen"을 입력하면 Doxygen Documentation Generator 라는 확장 기능이 검색된다.

마켓 플레이스에서 Doxygen Documentation Generator 검색

 

2. Install 버튼을 클릭하여 확장 기능을 설치한다.

Doxygen Documentation Generator 확장 기능 설치

 

 

Doxygen 주석 자동 생성

위 확장 기능이 설치되면, Doxygen 주석을 작성할 함수, 구조체, 변수 등에서 Doxygen 주석의 작성을 시작하면 Doxygen 주석 템플릿이 자동 생성된다.

 

예를 들어 다음과 같은 함수를 작성한 다음,

int test2(int a, int b)
{
  return a - b;
}

 

함수 정의문 바로 위 라인에서 Doxygen 주석의 시작 문자열인 "/**"를 입력하고 엔터를 입력하면 다음과 같이 Doxygen 주석 작성을 위한 템플릿이 자동 생성된다. 이를 통해 입력할 문자의 수를 줄일 수 있다.

아래 함수에 대해서 자동 생성된 Doxygen 주석 항목은 @brief, @param, @return 이다. 자동 생성된 항목 뒤에 설명만 추가하면 된다.

/**
 * @brief 
 * 
 * @param a 
 * @param b 
 * @return int 
 */
int test2(int a, int b)
{
  return a - b;
}

Doxygen 주석 템플릿 자동 생성

 

Doxygen을 사용하는 개발자에게는 매우 유용한 기능이므로 설치하는 것이 좋다.

 

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