Doxygen 소개와 설치하기

Financial Tech. 2007/12/13 09:45
















1장. Doxygen 소개와 설치하기
 
1. Doxygen의 소개
 
프로젝트 수행 중 문서화는 차후 유지보수를 위해 굉장히 중요합니다.
특히 사용자적인 관점의 문서화는 프로젝트 요구사항에 명시되어 제작되는 경우가 많지만 개발된 혹은 개발 중인 소스코드에 대해 분석을 위한 문서화는 아예 하지 않거나 하려고 하면 굉장히 많은 시간과 수고가 소요되게 됩니다.
 
그래서 개발 문서의 자동화를 위해 JAVA에서는 javadoc이라는 툴을 제공하여 특정형식의 주석을 문서화 시켜주게 됩니다.
이와 유사하게 오픈소스 진형에서는 Doxygen이라는 툴을 만들고 이를 지원합니다.
javadoc보다는 다양한 언어를와 형식을 지원하고 있으며 다른 모듈들과 연동하여 자동으로 관계도를 이미지로 만든다든가 pdf문서를 생성한다든가 하는 보다 더 향상된 기능을 제공합니다.


사용자 삽입 이미지






2. Doxygen 설치
 
 
1) doxygen 설치
 
우선 Doxygen을 다운받아야 겠죠?
 
Doxygen공식사이트 : http://doxygen.org, http://www.stack.nl/~dimitri/doxygen
Doxygen프로젝트사이트 : http://sourceforge.net/projects/doxygen/

Doxygen공식사이트에서 doxygen을 우선 다운 받으세요.
현재 최신버전은 1.5.3 이네요.
 
윈도우즈용에는 두가지 인스톨러로 되어 있는 doxygen-1.5.3-setup.exe가 있습니다. 이 설치파일이에는 간단하지만 GUI툴도 같이 포함되어 있습니다.
커맨드 상태에서 사용하고 싶다면 doxygen-1.5.3.windows.bin.zip 파일을 다운 받으세요.
커맨드 전용 doxygen에는 doxygen.exe와 doxytag.exe 딱 두개입니다. 이걸로 다운 받았다면 GUI 툴은 사용할 수 없구요. 설치라기 보다는 압축 풀고 그냥 PATH에 걸려 있는 디렉토리에 복사하면됩니다.
 
저는 윈도우즈용 설치 파일을 다운 받았습니다.
뭐 이것도 그냥 실행해서 Next만 쭉 누르면 설치됩니다.
설치를 마치면 "시작>모든프로그램"에 보면 다음의 그림과 같이 Doxygen이 설치된 것을 아실 수 있습니다.

사용자 삽입 이미지



우선 여기까지만 해도 설치가 끝난것입니다. 그러나 앞으로의 프로젝트를 위해 기본 Doxygen Template을 만들어 놓습니다.
우선 Doxygen Template을 저장할 디렉토리를 하나 만듭니다.
예로 C:\Doxygen 이라는 디렉토리를 만들었다면 컴맨드 창을 열어 C:\Doxygen으로 이동합니다.
다음과 같은 명령으로 기본 Doxygen Template을 만듭니다.

 
C:\Doxygen>doxygen -g

Configuration file `Doxyfile' created.

Now edit the configuration file and enter

doxygen Doxyfile to generate the documentation for your project

C:\Doxygen>

위와 같은 실행에 의해 Doxyfile이라는 파일이 하나 생겼습니다. 이 파일을 노트패드에서 열어서 다음의 부분을 수정합니다.
 
OUTPUT_LANGUAGE = Korean
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES       
SOURCE_BROWSER = YES
HAVE_DOT = YES


2) Graphviz 설치
 
Doxygen에서는 소스나 함수간의 관계 및 의존도를 특정 그림으로 보여 줄 수 있는 기능이 있습니다. 뭐 이 기능을 사용하지 않을 거라면 지금 설치하려는 Graphviz를 설치하지 않아도 되지만 기왕 하는 김이 있으면 더 좋겠죠? 그래서 Graphviz라는 것을 설치 합니다.
Graphviz는 그림(주로 순서도와 같은)을 그리기 위한 스크립트 언어인 dot이라는 특수한 언어를 이용하여 실제 jpg나 png파일들을 생성해 내는 그런 툴입니다.
Graphviz를 사용하는 법에 대해서도 또 다른 강좌를 써야 할 만큼 분량이 많지만... 여기서는 그냥 단순히 사용하는 것이기 때문에 설치 방법만 설명합니다. 실제로 dot스크립트 파일은 Doxygen이 자동으로 만들어 줍니다.
 
Graphviz의 공식사이트: http://www.graphviz.org/
 
위의 사이트에 가셔서 윈도우즈용 설치 파일을 다운 받으세요.
이 역시 인스톨러로 묶여 있는 버전(graphviz-2.14.exe)과 그냥 바이너리를 압축해 놓은 파일(graphviz-win-2.14.bin.tar.gz)을 같이 제공하는데...
저는 그냥 압축버전을 다운 받았습니다. 왜냐면... 현재 저 입장에서는 상당 기간동안 Graphviz를 Doxygen에서 사용하는 것외에 다른 용도로 사용하진 않을 듯 싶어 시작 프로그램이나 프로그램 추가삭제 같은 곳에 등록하는것이 나름 부담스러워서 입니다. 뭐 이건 제 개인 취향이니까 여러분들은 하고 싶은대로 하세요.
제가 이글을 쓰는 시점에서 최신버전은  2.14입니다.
 
graphviz-win-2.14.bin.tar.gz파일의 압축을 풀어 폴더 이름을 Graphviz-2.1.4라는 이름으로 수정하고 "C:\Program Files" 폴더 아래에 복사하였습니다.
 
3) Microsoft HTML Help Workshop 설치
 
Doxygen에서는 문서화의 결과로 HTML문서들을 생성할 수 있습니다. 이들 HTML을 웹에 올려서 사용할 수도 있지만 윈도우즈의 도움말 포맷인 chm과 같은 파일을 만들어서 볼 수도 있겠죠?
Doxygen에서는 문서화 작업을 할 때 최종적으로 chm파일을 만들 수 있는데 이때 필요한 툴이 바로 Microsoft에서 제공하는 HTML Help Workshop입니다. 그 중에서는 H
 
HTML Hlep를 다운받을 수 있는 곳: http://msdn2.microsoft.com/en-us/library/ms669985.aspx
 
위의 웹사이트에서 Htmlhelp.exe파일을 다운 받아 그냥 설치하시면 됩니다.
 
그냥 실행해서 next만 누르세요.
 
4) LaTeX 설치
 
Doxygen으로 LaTeX문서를 만들 수 있습니다.
이 LaTeX문서를 이용하여 tex파일을 dvi파일로 만들거나 gs문서를 만들거나 pdf문서를 만들 수 있습니다.
하지만 현재까지 제가 해본 바로는 한글에 문제가 있는 듯 합니다.
성공하신 분이 있으시다면 할말은 없지만... (제가 Tex를 잘 몰라서...)
혹시 시도를 해 볼 분을 위해  LaTex관련 URL만 적어놓습니다.
 
TeX사용자 그룹: http://www.tug.org
TeXLive-teTeX for MacOS X: http://www.rna.nl/tex.html
 
위의 Tex관련 프로그램 중 윈도우즈에서는 MikTeX가 초보자들이 쉽게 사용할 수 있는 Tex인것 같습니다. 단, 영문만 가능하다는거...
 
한글 Tex사용자 그룹: http://www.ktug.or.kr/
 
 
5) GhostScript-x 설치
 
일반적으로 tex문서를 dvi로 만든 후 dvi를 ps파일로 만든 다음 ps파일을 gs나 pdf문서로 만들 수 있습니다.
이때 ps파일을 이용하여 gs나 pdf파일을 만들때 필요한 프로그램이 GhostScript-x입니다.
GhostScript-x를 설치하면 gswin32c.exe파일이 복사되게 되는데 이 파일을 이용하여 Doxygen은 pdf나 gs파일을 생성하게 됩니다.
 
지금 Doxygen에서는 LaTex의 문제로 인해 한글을 지원하지 못 합니다.
그런 이유로 를 설치해서 tex파일을 이용하여 GhostScript-x를 통해 pdf나 gs를 만들때도 한글이 처리되지 않습니다. (제가 못하는 것일 수도 있음...) 고로 한글을 사용하시려면 pdf는 포기하시고 영문으로만 처리하실려면 설치하세요.
 
ghostscript-x 공식사이트: http://pages.cs.wisc.edu/~ghost/
 
윈도우즈용 설치파일인 gs854w32.exe을 다운 받아 실행하십시오.
실행 중에 아래와 같은 화면이 나타나는데...
한글 TrueType 글꼴을 사용하기 위해 붉은색으로 표시한 부분을 체크하세요.
현재 버전은 8.54입니다.


사용자 삽입 이미지































6) doxbar 설치
 
Doxygen을 Microsoft Visual Studio 6.0에서 통합하여 사용하고 싶다면 doxbar를 다운 받아 설치하면 됩니다. doxbar가 사용에 편리하다 않하다의 상반된 의견이 있기 하지만... 그것에 대한 판단은 여러분의 몫이므로 필요하다면 다운받으세요.
 
 
현재 최신버전은 0.38이네요. doxbar-0.38-bin.zip파일을 다운받아 압축을 풉니다.
압축을 불편 doxbar.chm과 doxbar.dll 이렇게 두개의 파일이 나오는데 이들 파일을 적당한 디렉토리에 복사합니다. Visual Studio 6.0의 애드인 디렉토리(C:\Program Files\Microsoft Visual Studio\Common\MSDev98\AddIns)로 복사해도 상관없습니다.
 
Visual Studio를 열어서 메뉴의 "Tools>Customize" 선택합니다.
Customize 대화상장의 제일 마지막 탭인 "Add-ins and Macro Files" 탭을 선택해서 "Browse"버튼을 클릭해서 방금 복사한 doxbar.dll 파일을 선택하고 확인을 눌러줍니다.
그러면 다음의 그림과 같이 Doxbar.DSAddIn.1 이라는 항목이 나타납니다.

사용자 삽입 이미지



체크상태로 Close버튼을 누르면 다음과 같은 툴바가 나타납니다.

사용자 삽입 이미지





아직 설정이 다 끝난건 아닙니다.
 
다시 메뉴에서 "Tools>Customize"를 선택하고 대화상자의 Tools를 선택하세요.
"Menu contents"창에서 스크롤바를 제일 아래로 내려서 빈란을 더블클릭해서 Doxygen이라고 적습니다.
그런다음 "Command" 에디트 박스에 "D:\AppData\Doxygen\rundox.bat" 라고 적습니다.
또한 "Initial directory" 에디트 박스에 "$(CurDir)" 을 입력하세요.
그리고 출력 메시지가 IDE의 Output Window에 출력되게 하기 위해 "Use Output Window" 체크박스에 체크하세요.
여기서 "D:\AppData\Doxygen\rundox.bat" 파일은 현재는 없습니다. 이는 doxbar가 실행되면서 만드는 일괄처리 파일입니다. 눈치 채셨겠지만 파일이름이나 경로는 바꿔도 상관없습니다.


사용자 삽입 이미지



여기까지 하고 "Close"버튼을 누르면 rundox.bat파일이 없다고 경고 대화상자가 나타나는데 그냥 "아니오"눌러서 나오십시오.
 
다시 메뉴에서 "Tools"를 클릭하면 "Doxygen"이 몇번으로 등록되어 있는지 확인하세요.

사용자 삽입 이미지































저는 8번으로 되어 있네요. 그러나 이 번호는 여러분의 개발 환경에 따라 달라질 수 있습니다. 어찌되었건 확인했다면 Doxbar 툴바에서 2번째에 있는 "Configure Doxbar" 버튼을 클릭하세요.


사용자 삽입 이미지




사용자 삽입 이미지




다시 "File locatoins"라는 탭을 선택하고 아래의 그림을 참조해서 적습니다.

사용자 삽입 이미지



"Batch file"은 Doxbar를 등록할때 지정했던 배치파일의 전체 경로를 적은 것입니다.
Doxygen은 doxygen.exe파일이 존재하는 실제 경로를 적는 부분입니다.
"Configuration template"은 Doxygen 설치 후에 만들었던 기본 Doxygen Template을 입력하는 부분입니다.
"HTML Help compiler"는 HTML Help Workshop의 hhc.exe파일의 경로를 설정하는 부분입니다.
 
여기까지 지정하셨다면 "확인"을 눌러서 설정을 마침니다.
 
 
 
5) 그밖의 Doxygen 관련 툴
 
위에서 이야기한 툴들외에도 다음과 같은 툴이 있는데 저도 모두 사용해 보지는 않아 말씀은 더 못 드리겠습니다.
다음에 제가 필요에 의해 설치하거나 사용하게 되면 이 글을 수정하도록 하겠습니다.
 
- Visual Studio .Net Add-in
http://www.codeproject.com/macro/KingsTools.asp  VS.NET 2003용
http://my.dreamwiz.com/ospace/KingsTool/KingsSetup.zip  VS.NET 2005용
http://doxycomment.sourceforge.net/  VS.NET 2005용
http://www.feinsoftware.com/products.php (유료)
 
- Ant 관련
http://ant-doxygen.sourceforge.net/

참고로 첨부파일로 위의 다운받아야 할 것들을 모두 올려 놓았으니 최신버전이 아니라도 괜찮다거나 각 사이트 가서 다운받기 귀찮다고 하시면 그냥 첨부파일 다운 받아 사용하세요.

'Financial Tech.' 카테고리의 다른 글

펀드 관련 용어 잔고수량 평가금액  (0) 2008/01/22
Doxygen 소개와 설치하기  (0) 2007/12/13
‘분양가 상한’ 파주신도시 1순위 청약 미달  (0) 2007/11/30
링크드 리스트  (0) 2007/11/22
용인 흥덕지구 향후 전망..  (0) 2007/11/09
왜 신생기업은 망하는가? 성공적인 비즈니스를 위한 전문가의 조언  (0) 2007/10/02
'72법칙'으로 수익률 따져보자  (0) 2007/09/30
투자는 전쟁이다  (0) 2007/09/21
청약자들의 위험한 발상  (0) 2007/09/21
투자성공의 기본은 투자공부다  (0) 2007/09/21
청약 가점제 언제쯤 정착될까?  (0) 2007/09/21
Posted by Hangenie
트랙백 0개, 댓글 0개가 달렸습니다

트랙백 주소 :: http://hangenie.com/trackback/262

댓글을 달아 주세요