[[TableOfContents]] == Doxygen은 무엇인가? == Doxygen 은 C, C++, JAVA등의 소스를 자동으로 문서화 시키는 Tool이다. 물론 아무것도 안하고 자동화 시키는것이 아니다. Doxygen은 C, C++, JAVA 주석을 이용하여 문서화를 하는것이다. 그래서 주석을 달때 주석에 조금 특별하게 다는것이다. == C언어 예제 == hello world 라는 유명한 소스로 한번 문서화를 해보겠다. Doxygen은 문서화할때 html, 워드파일 doc(rtf 포멧), pdf, Latex(dvi), ..등 여러가지 파일로 만들수 있다. 하지만 여기서는 웹이기때문에 일단 웹으로만 보여 주겠다. === hello.c === {{{#!vim c /** @file GetAge.c @brief 시험 작성. */ #include /** @brief hello Main 함수. @author 박지훈 @date 2013-03-31 09:30:00 @return 입력 받은 나이 값. */ char* getAge() { static char Age[128]; /// printf( "Your Age : " ); scanf( "%s", Age ); return Age; } int main() { char *str; str = getAge(); printf( "My Age is %s\n", str ); return 0; } }}} === Doxygen으로 문서화한 것 === 아래의 링크를 클릭하여 문서한것을 보자. {{{#!html
}}} {{{#!html
}}} == 직접 해보기 == 위에서 작성한 hello.c파일을 직접한번 만들어 보자. 일단 필요한것이 있다. 무엇일까? 음.. 생각나지 않는다면 이 문서를 왜 보는지 생각해 보자. 바로 Doxygen이다. === Doxygen설치 === 일단 Doxygen을 다운 받고 설치를 해야 한다. 제 회사 환경이 Windog(ㅠㅠ) 환경이므로 Windog Doxygen을 받아서 설치해보겠다. [http://www.doxygen.org/ Doxygen 홈페이지]에 가서 우측 메뉴에 있는 Download탭에 가서 Doxygen을 받아 설치한다. [http://ftp.stack.nl/pub/users/dimitri/doxygen-1.4.2-setup.exe Window용 Doxygen]을 다운받아 설치한다. 무조건 next->next 하면 깔린다. (-_-;;) 귀찮니즘 발동으로 생략하겠다. === hello.c 파일 작성 === 위에 나온 hello.c 파일을 작성하여 임의의 Directory에 저장시킨다. (필자는 D:\Doxygen 으로 하겠다.) === 문서화 하기 === 시작메뉴 --> 프로그램 --> doxygen --> doxywizard 를 실행한다. 실행하면 아래와 같은 화면이 나온다. attachment:doxywizard_start.gif ==== Step1 Doxygen 설정파일 만들기 ==== Step1의 Wizard를 클릭한다. 그러면 아래의 화면이 나온다. ===== Wizard - Project 탭 ===== attachment:doxywizard_project.gif Poject 탭 project name 에 프로젝트 명을 쓴다. 현재 Doxygen버그로 한글이 깨지니 영어로 써라. 여기서는 Hello 로 하겠다. 아래 사항을 입력하라. '''현재 한글 directory명을 쓰면 되지 않는다.''' || 입력사항 || 설명 || 입력할것 || || Project name || 프로젝트 이름이며 필수 || hello || || Project version or id || 프로젝트 버전 필수 아님 || 0.1 || || Source code directory || 소스 파일 directory 필수아님 || || || Destination directory || 문서를 출력할 dirctory 필수아님 || || 필자의 작업 dirctory를 d:\Doxygen했기 때문에 D:\Doxygen으로 했다. ===== Wizard - Mode 탭 ===== 이제 Mode 탭이다. attachment:doxywizard_wizard_mode.gif 여기서는 제일 하단의 Optimize C output을 선택한다.(C 문서 최적화) ===== Wizard - Output 탭(문서 파일출력 종류) ===== 이제 output탭.(여기를 파일 출력에 대한 탭이다) attachment:doxywizard_wizard_output.gif 여기서 html과 Rich Text Format(RTF)를 선택하자. html은 다들 아시겠고 Rich Text Format(RTF) 는 워드파일(doc)과 거의 같다고 보시면 되겠다.(워드에서 열린다.) 이제 거의 끝났다. OK 버튼을 눌러 다시 원래 화면으로 나온다. ===== Expert - Project ===== attachment:doxywizard_start.gif 위 화면에서 Expert... 버튼을 눌러 한국어 설정을 하고 빠져 나온다. attachment:doxywizard_expert1.gif ==== Step2 설정파일 저장 ==== 이제 아래 화면에서 attachment:doxywizard_start.gif Step2의 Save를 눌러 D:\Doxygen\Doxyfile로 저장하시고 ==== Step3 작업 Directory 지정 ==== Step3에서 Working directory에 D:\Doxygen\를 입력후 attachment:doxywizard_step3.gif ==== Step4 Doxygen 실행 ==== Step4어서 Start버튼을 눌러 작동 하면 된다. attachment:doxywizard_step4.gif ==== 문서 보기 ==== 그러면 D:\Doxygen 에 html Dirctory와 rtf Directory가 생겼을 것이다. {{{#!vim bash D:\Doxygen>dir /w /s D:\Doxygen 디렉터리 [.] [..] hello.c Doxyfile [html] [rtf] 2개 파일 9,798 바이트 D:\Doxygen\html 디렉터리 [.] [..] doxygen.png doxygen.css index.html files.html hello_8c.html dir_000000.html dir_000001.html dirs.html globals.html globals_func.html 10개 파일 19,070 바이트 D:\Doxygen\rtf 디렉터리 [.] [..] refman.rtf 1개 파일 26,048 바이트 D:\Doxygen> }}} 그곳에 가서 문서를 열면 멋진 html과 doc파일이 보일것이다.^^ * rtf파일은 워드에서 열어서 Ctrl + a 로 '''전체 선택'''후 '''오른쪽 마우스 버튼을 클릭'''후에 '''필드 업데이트'''를 선택해줘야 합니다. == 맺음말 == 다음 강좌는 위의 hello.c 소스파일을 분석해보겠습니다. == 작성자정보 == [infiniterun] Email : infiniterun---no spam---gmail.com == 댓글 == [[Comment]]