Doxygen과 Graphviz

소개 및 설치와 설정

Doxygen이란?

Doxygen은 소스파일에 작성된 내용을 바탕으로 문서 파일을 생성해주는 프로그램입니다.
지원하는 프로그래밍 언어로는 C, C++, Object-C, C#, PHP, JAVA, Python, Fortran 등이 있습니다.
사용자가 소스파일에 Doxygen에서 정해준 형식대로 주석을 작성하였을 경우, 생성될 문서에 각 형식에 맞춰 작성한 내용이 첨부됩니다.
자세한 정보는 Doxygen 홈페이지를 통해 확인하실 수 있습니다.

Graphviz란?

Graphviz는 그래프로 시각화해주는 여러 도구들의 모음입니다.
기본적으로 'DOT'라는 언어를 사용하지만, 제공하는 라이브러리를 이용하면 여러 프로그래밍 언어에서도 사용하실 수 있습니다.
그래프로 시각화된 내용은 제공하는 여러 파일 포맷으로 결과물을 확인하실 수 있습니다. 지원하는 파일 포맷이 궁금하신 분은 Graphviz 홈페이지를 참고하시길 바랍니다.
Doxygen에서는 파일간 종속관계, 함수 호출 관계, 클래스 계층 등을 그래프로 표현할 때 사용하며, 생성된 결과물은 문서에 첨부됩니다.

다운로드하기

Doxygen은 홈페이지 내 Downloads 메뉴를 선택하신 뒤, 중간에 위치한 doxygen-버전-setup.exe 항목을 다운로드합니다.

Graphviz는 홈페이지 내 Download 메뉴에서 windows 항목을 선택하신 뒤, graphviz-버전.msi 항목을 다운로드합니다.

설치하기

Doxygen과 Graphviz는 일반 응용프로그램 설치와 크게 다른점이 없습니다. 하지만, Doxygen 설치 과정에서 'doxywizard GUI' 항목이 체크된 상태로 설치할 수 있도록 주의해야 합니다.

설정하기

시작 메뉴에서 Doxygen 설치로 인해 생성된 'Doxywizard' 프로그램을 찾아 실행합니다.
실행 후 아래 단계를 걸쳐 보다 체계적인 문서가 생성될 수 있도록 합니다.

저장하기

'Doxywizard' 프로그램은 기존에 설정한 내용을 보관하지 않습니다. 따라서, 아래와 같이 문서가 정상적으로 생성되면, 지금까지 설정한 내용을 저장하도록 합니다.

불러오기

마무리

본 글에서는, 기본적인 Doxygen 사용법과 Graphviz를 연계하는 방법을 소개하였습니다.
위에 작성된 설정만으로도 기본적인 문서를 생성할 수 있지만, 보다 체계적인 문서화를 생성하시고 싶으신 분은 Doxygen에서 정해준 주석 형식과 지원하는 특별한 명령어를 참고하여 주석을 작성해주시면 됩니다.