[Tool, C/C++] Doxygen(문서 분석기)

소개툴)_

이번에 소개할 Tool은 Doxygen 입니다.
이 Doxygen은 문서 분석기로써 일정한 형태로 주석을 기입해 놓으면
코드의 흐름을 웹문서로 출력해주는 편리한 기능을 제공합니다.

주석 방식을 아래서 설명하겠지만
설명이 부족하신 분을 위하여 샘플을 별첨합니다.
첨부파일:

main.cpp

설치방법)_

먼저 독시잰을 설치합니다.
google같은대서 독시잰 혹은 Doxgen 이라 검색하면 아래와 같은 주소가 나옵니다.
http://www.stack.nl/~dimitri/doxygen/

이곳에 가셔서 Download > Sources and Binaries로 가시면
for Windows 에서 사용하실 수 있는 독시잰을 내려받습니다.

설치는 쭉~쭉~ 하시면 되시고요

그 다음은 독시잰의 부속 프로그램을 하나 소개하려합니다.
http://www.graphviz.org/

이 곳에 가셔서 Download > Stable and development Windows Install packages로 가시면
current stable release에 있는 것을 내려 받아 설치하시면 됩니다.

이용방법)_

설치가 끝나셨으면 이용방법을 알아보도록 하겠습니다.
이용방법은 4가지로 정리해 드리도록 하겠습니다.

[Doxygen방식 주석]
Doxygen으로 문서 프로그램 문서 출력을 명세하기 위해서는
Doxygen에서 규정한 주석방식으로 주석을 기입하셔야 합니다.

Doxygen명시 주석)_
주석의 형태는 다음과 같습니다.
/**
주석내용
*/

주석은 반드시 해당 소스 바로 윗줄에 있어야합니다.

예로 다음과 같은 형태가 되어야 하며
/**
 * @brief list객체
 */
class list
{};

만약 바로 윗줄에 연관있는 다른것을 반드시 표기하면서
주석을 달기 원할때는 다음과 같은 방식으로 작성하셔야 합니다.
/**
 * @class list
 * @brief list객체
 */
class member;
class list
{};

기본설명은 여기까지며 이하는 주석으로 기입할 Item을 소개 하겠습니다.

Item	설명
@author	작성자 이름
@brief	간략한 설명
@bug	발견된 버그의 설명
@code	중요 코드를 설명할 때 시작 지점 설정
@date	작성날짜
@endcode	중요코드 설명할 때 종료 지점 설정
@exception	예외 처리
@mainpage
@param	함수 파라미터
@remark	자세한 설명
@return	함수의 리턴 값
@section
@see	참고할 함수나 페이지 지정
@todo	해야할 일의 설명

이하는 기타 지정 명기사항 입니다.

Item	설명
@struct	구조체를 지정
@class	객체를 지정
@fn	함수를 지정
@enum	열거형을 지정
@def	메크로를 지정
@file	파일을 지정

[한글출력 문제]
특별한 설정을 한적없는 코드파일을 독시젠으로 출력할 경우
한글 주석이 있을때 이 한글이 깨져 나오는 경우가 많습니다.
이는 인코딩 문제로 해결방법은 다음과 같습니다.

위의 이미지와 같이 Expert > Project에서
DOXYFILE_ENCODING에 EUC-KR이라 적어주신후
OUTPUT_LANGUAGE를 Korean로 선택합니다.

그다음은 Input에서 INPUT_ENCODING에
CP949라고 적어주시면 됩니다.

[Diagrams 이미지출력]
Doxygen으로 문서를 출력할때 프로그램의 각 흐름을 Diagrams로 표시해주는 기능이 있습니다.
이기능은 보통 언어를 통해서 자체 생산해 표기를 해주는데요
옵션중에는 Image로 표시를 해주는 기능도 존재합니다.

이를 위해 위에서 graphviz을 설치하였는데요
이를 이용하려면 약간의 설정이 필요합니다.

설정방법은 Expert > Dot에서
DOT_PATH를 설치한 GraphViz의 경로로 설정하시면 됩니다.

예로 C드라이브에 설치 하셨다 했을때 경로는 다음과 같습니다.
C:/Program Files (x86)/Graphviz2.30/bin

[문서 출력]
이제 모든 설정 방법을 알았으니 이번엔 문서로 출력하는 방법을 알려드리겠습니다.

사용방법은 위의 이미지와 같이 하시면 됩니다.

먼저 Setp1 부분은 독시잰의 실행동안
작업할 임시공간을 지정하는곳 입니다.
적당히 아무대나 지정해 두시면 됩니다.

Wizard > Project)_
Project name부분에 출력하실 이름을 기입을 합니다.
Source cod directory는 분석할 프로젝트를 선택하시면 됩니다.
이때 Scan recursively를 체크 합니다.

Destination directory는 완성된 문서를 저장할 위치입니다.
저장할 위치를 잘선택하시면 됩니다.

Wizard > Mode)_
대상을 어떻게 문서화 할지에 대해 설정하는 곳입니다.
All Enities를 선택하시면 관련된 전부가 출력됩니다.

Include cross-referenced source code in the ouput은
포함파일의 상관관계를 문서화 할지에 대한 설정입니다.

그 아래 설정은 현재 작성된 문서의 언어 형식에 관한 선택입니다.
저는 기본 C++을 샘플로 테스트한 관계로 첫번째를 선택 하였습니다.

Wizard > Output)_
결과 출력을 설정하는 곳입니다.
기본적으로 HTML설정이 되어있으니 그냥 넘어갑니다.

Wizard > Diagrams)_
이곳은 다이어그램을 어떻게 출력할지 설정하는 곳입니다.
일단 아까 설치한것이 잘작동하는지 확인하기 위해서
Use dot tool from the GraphViz package를 선택후
아래 모든 내용을 체크를 합니다.

Run)_
Run doxygen을 누루신후
Status: not running과 Doxygen has finished가 뜨기를 기다립니다.

모든작업이 완료되면
Show HTML output을 눌러 내용을 확인합니다.

마무리로 위와같은 일련의 설정 과정은
File의 Save기능을 통하여 설정을 저장해두실 수 있습니다.

이 외의 기타 사용에 관련된 내용은 아래의 블로그를 참고하시면 되겠습니다.
http://blog.daum.net/chungs95/6388270