VIM 주석을 달아보자 (Doxygen)

프로그램을 협업으로 개발하다보면 어느정도 규칙이 필요하다. 그렇지 않고 본인 스타일대로 개발을 시작하면 나중에 merge된 소스는 엉망이 될 수 있기 때문이다. 이런 사태를 방지하기 위해 프로그래밍 규칙은 변수명, 함수 스타일, 들여쓰기 등등이 있지만 여기서는 주석에 대해 다뤄본다. (이러한 규칙은 프로젝트 별로 다르고, 언어마다 천차만별이다.)

이 포스팅은 주석을 일관된 형식에 맞춰 달 수 있도록 도와주는 툴킷인 Doxygen에 대한 설명이다. 우선 Doxygen은 Vim의 툴킷으로 아래 링크에서 다운로드할 수 있다.
http://www.vim.org/scripts/script.php?script_id=987

본인이 사용하는 Vim의 버전에 맞는 툴킷을 받아 설치하도록 하자. 설치는 다운로드 받은 DoxygenToolkit.vim 파일을 ~/.vim/plugin 디렉터리로 복사만 하면 된다. 

사용법은 무척 간단한데 아래 예제를 통해 살펴보자.

커서는 주석을 달고자 하는 문장에 둬야 한다. (함수, 구조체, 변수 모두 가능하다.) 그리고 커맨드 모드로 아래 명령어를 입력해보자.

:Dox

아래와 같은 스타일의 주석이 생성된 것을 확인할 수 있다. 또한 입력 모드로 변경되어 바로 주석을 이어서 작성할 수 있다.

이번에는 func 함수에 주석을 달아본다. 파라메타가 모두 노출되어 각 파라메타의 역할을 명시 할 수 있다.

이외에도 DoxAuthor, DoxBlock, DoxLic, DoxUndoc 같은 재밌는 명령어가 추가로 제공되니 살펴보도록 하고, 이제 Doxygen을 활용해서 프로젝트에서 모든 개발자가 일관된 주석을 사용할 수 있기를 기대해본다.