[기타 - 독시젠(Doxygen) 사용법(1)]

Intro

---

이번 포스팅에서는 개발자들이 개발한 코드를 문서화할 때 사용하는 Doxygen이란 걸 소개하도록 하겠습니다.
오픈소스 기반 프로젝트를 개발하거나 SDK 별도로 받아 개발할 때 레퍼런스(개발자 문서)를 참조해서 개발해본 경험이 있으실 겁니다.
Doxygen은 개발자들이 개발한 코드에 주석을 작성하면 주석이 달린 코드를 읽어 자동으로 문서를 만들어내는 소프트웨어 레퍼런스 문서 생성기입니다. 저 같은 경우 주로 SDK를 외부에 배포할 때 자주 사용하는데 정말 편리하고 좋습니다. 이번 포스팅에서 doxgen에 관한 전반적인 소개와 Doxygen 다운로드, 설치, 사용법, 주석 방법, 실제 배포할 때 html 파일을 chm파일로 묶어서 배포하는 것 까지 포스팅하겠습니다. 포스팅 내용이 길어질 거 같아서 2번에 나눠서 포스팅하도록 하겠습니다.

Doxygen

---

Doxygen이란?

주석이 달린 코드를 읽어내 문서를 만드는 소프트웨어 레퍼런스 문서 생성기입니다. 문서의 결과는 보통 HTML로 나오거나, 설정하는 환경에 따라 Word 파일, PDF 파일로 변환하여 만들 수 있습니다. 코드 내의 정해진 규칙에 짜여진 주석으로부터 정보를 읽어오며, 규칙만 지키면 모든 언어의 정보를 읽어 올 수 있습니다.

왜 Doxygen을 사용하나?

Doxygen 양식에 맞는 정해진 주석을 공통적으로 사용하면 다른 사람이 소스코드를 이해하기 편리합니다. 또한 보통 소스 코드 작성 후 별도로 문서를 작성하는데 매우 번거롭습니다. 하지만 Doxygen을 사용하면 문서와 코드의 동기화가 가능하여 빠르고 효율적으로 문서 관리가 가능합니다.

Doxygen 다운로드 및 설치 방법

1. 다운로드. Windows 버전을 다운로드 해줍니다.
   Doxygen다운
   
2. 설치. Next를 눌러주며 설치해줍니다.
   
   
   
   
   

Doxygen 사용법

실행 파일 클릭(Doxywizard.exe)
Project 설정

1. 프로젝트 루트 폴더 지정
2. 프로젝트 이름 설정
3. 프로젝트 개요 설정
4. 프로젝트 버전 입력
5. 문서 로고 선택
6. 소스 코드 파일 위치 설정
7. 하위 폴더의 모든 코드를 문서화할지 여부
8. Doxygen 문서 생성 폴더
9. 다음 step

Mode 설정

1. 문서 or 문서+소스코드 선택
2. 프로그래밍 언어 선택
3. 다음 step

Output설정

1. 포맷 설정
2. 생성 파일 설정
3. 다음 setp

Diagrams 설정

1. Diagram 설정
2. 다음 step

Run 설정

1. 문서 생성
2. 설정 보기
3. HTML 파일 미리 보기

마무리

---

이번 포스팅은 내용이 길어져서 .. 2번으로 나누어 포스팅 하겠습니다.이상으로 포스팅을 마치겠습니다. 다음 포스팅에서는 실제 배포할 때 html 파일을 chm파일로 묶어서 배포하는 것 까지 포스팅하겠습니다.