Contents:
- 1 Doxygen 이란?
- 2 설치하기
- 2.1 Doxygen, Graphviz, HTML Help Workshop 설치하기
- 2.2 Doxbar 설치하기
- 2.3 Doxygen 실행
- 3 관련링크
소스 코드를 문서화 한다는 것은 매우 힘든 작업으로 대부분의 프로그래머들이 싫어하는 작업 중 하나일 것이다. 그래서 이런 귀찮은 일을 어떻게 하면 자동화 할 수 있을까 하는 생각에서 탄생했지 않을까 추측해 볼 수 있다. 일반적으로 프로그래머들의 문서화라면 소스에 주석을 다는것 이외에 또 다른 손쉬운 방법이 있을까? 따라서 이런 주석을 문서화 시키는 프로그램이 Doxygen 이다. 시작은 Unix/Linux 에서 시작된 것 같지만 지금은 Windows 에서도 사용할 수 있으며 Visual Studio 에서도 손쉽게 사용할 수 있게 되었다. 그럼, Doxygen 을 어떻게 설치하며 사용하는지 알아 보자.
참고> Doxygen 은 ![[http]](/wiki2/imgs/http.png)
RedPixel 님의 Doxygen 관련 글을 보고 배우게 되었습니다.
Doxygen 은 Visual Studio 에서 편리하게 사용하기 위해서는 몇가지의 다양한 프로그램의 조합
.gif ";)")
이 필요하다. 설치해야 할 프로그램은 모두 4 가지로
ProgrammingTools 의
Documentation Tools 에서 찾을 수 있으며 링크를 따라 다운로드 하면 된다. 그리고 4 가지 모두다 공개 소프트웨어 이므로 라이센스 걱정은 할 필요없다.
2.1 Doxygen, Graphviz, HTML Help Workshop 설치하기 #
3 가지 모두 자동 설치 프로그램으로 배포되고 있다. 따라서 그냥 다운 받아서 원하는 디렉토리에 설치하면 된다. 그리고 Doxygen 은 설정파일을 만들어야 하는데 아래의 설정하기 를 참고하면 손쉽게 만들수 있다.
위의 3가지 프로그램과 달리 자동 설치가 되지 않으므로 수동 설치가 필요하다. 압축을 풀면 doxbar.dll 과 도움말 파일이 있는데 이 중에서 doxbar.dll 을 Visual Studio 의 Addins 디렉토리에 복사하면 된다.
참고> Visual Studio 를 기본값으로 설치했다면 Addins 디렉토리의 경로는 다음과 같다.
C:\Program Files\Microsoft Visual Studio\Common\MSDev98\AddIns
Doxbar 도 Doxygen 과 같이 설정이 필요하다. 하지만 위의 3 가지 프로그램을 연결하는 역활을 하므로 좀 더 복잡한 설정이 필요하다.
설정은 다음과 같이 Doxygen 과 Doxbar 로 나누어 이루어지게 되며 순서대로 설정한다.
Doxygen 은 문서화 도구의 핵심으로 여러가지 옵션 설정이 필요하다. 먼저 Template 파일을 만들어야 한다. Template 파일은 새로운 프로젝트를 만들때 사용하는 기본 옵션값을 설정하는 파일로 한번만 설정하면 계속 사용할 수 있다. 다음과 같이 명령창에서 실행하면 Doxyfile 이라는 기본 Template 파일이 생성된다.
자동으로 만들어진 Template 파일은 적당한 디렉토리에 옮겨서 아래의 Doxbar 에서 설정하게 된다. 보통은 Doxygen 이 설치된 곳에 Templates 디렉토리를 만든후 Template 파일을 옮기면 된다.
- Doxyfile 옵션 설명
| 옵 션 | 설정값 | 설 명 |
| OUTPUT_LANGUAGE | Korean | 문서화할 언어를 선택한다. |
| EXTRACT_ALL | YES | 생성후 비어있는 문서 항목들도 모두 표시한다. |
| EXTRACT_PRIVATE | YES | Private 맴버들을 문서화할 것인지 여부를 설정한다. |
| EXTRACT_STATIC | YES | Static 맴버들을 문서화할 것인지 여부를 결정한다. |
| SOURCE_BROWSER | YES | 소스에 대한 직접적인 정보링크를 만들것인지 여부를 설정한다. |
| HAVE_DOT | YES | 클래스나 프로그램의 관계를 도표로 만들것인리 여부를 설정한다. |
- Doxygen 설정 파일 샘플
3.2 Doxbar 설정하기 #
Doxbar 를 설정할려면 먼저 Doxbar 를 활성화시켜서 사용 가능하도록 만들어야 한다. Visual Studio 의 [Tools] - [Customize] 메뉴에서 아래 그림과 같이 [Add-ins and Macro Files] 탭을 선택한 후 Doxbar 를 체크한다.
그렇게하면 다음과 같은 Doxbar 가 나타나게 된다.
Doxbar 가 활성화 되었으면, 이제는 Doxygen 을 등록한다. Doxygen 은 외부 프로그램으로 동작하게 되므로 Visual Studio 의
[Tools] -
[Customize] 메뉴의
[Tools] 탭에서 등록해야 한다. Doxygen 등록시 아래 그림과 같이 3가지를 설정해야 한다.
- Command 는 윈도우 디렉토리( Windows 2000 같은 경우 C:\WINNT ) 의 Temp 디렉토리에 runbox.bat 라는 파일로 설정한다.
- Initial directory 는 Workspace 디렉토리를 나타내는 $(WkspDir) 를 설정한다.
- Use Output Window 는 실행된 결과를 확인할 수 있도록 체크한다.
Doxygen 설정을 완료하고 Close 버튼을 클릭하면 runbox.bat 파일이 존재하지 않는다는 메세지창이 나타난다. 하지만 runbox.bat 파일은 Doxbar 를 실행할 때 자동으로 만들어지게 되므로 무시하고
[아니오] 를 선택하면 된다.
Doxygen 이 제대로 등록되었는지 확인하기 위해서 Visual Studio 의
[Tools] 메뉴를 연다. 위의 그림에서는
6 번 으로 등록되어 있지만 다른 번호로 설정될 수도 있다. 그리고
6 번 이라는 것을 기억해 두었다가 아래의 Doxbar 설정에 다시 설정한다.
Doxbar 의 설정은 아래의 그림에서 볼 수 있듯이 설정 아이콘을 클릭하면 된다.
먼저 Doxbar 설정창의
[User Tool] 탭에서 앞에서 Doxygen 를 등록되었을 때 번호를 아래의 그림과 같이
UserTool+번호 로 설정한다.
다음은 위에서 설치한 프로그램들을 연결하기 위한 설정이다.
- Doxygen 과 HTML Help Compiler 는 각각 설치된 디렉토리의 각 프로그램을 설정한다.
- Configuration template 은 앞에서 생성된 Doxyfile 을 지정한다.
- Batch file 은 Visual Studio 에 Doxygen 을 설정할 때 Commmand 란에 입력한 runbox.bat 를 설정한다.
여기까지가 Doxygen 과 Doxbar 를 실행하기 위한 최소한 설정이다. 따라서 그 이외의 설정은 도움말이나 각 홈페이지를 참고한다.
위와 같이 Doxygen 과 Doxbar 는 설정하기에 까다롭지만 실행은 매우 간단하다. 아래의 그림과 같이 실행 버튼을 클릭하면 된다.
에러없이 실행이 완료되며 프로젝트 디렉토리에
html 디렉토리가 생성되면서 거기에 문서화된 html 파일과 설정에 따라 도움말 ( *.CHM ) 형태의 문서화 파일이 생성 된다. 자세한 설명을 덧붙이기 위해서는 지정된
주석태그 를 삽입해야 하지만 그 부분은 Doxygen 의 도움말이나 홈페이지를 참고하기 바란다.
Doxygen/Doxyfile.zip
