[Doxygen] Windows 10에 Doxygen 설치하기

코드를 작성하고 시간이 지난 후 다시 보면, 내가 작성한 코드지만 금방 이해하기가 어렵다. 주석을 이용해 설명을 적는다고 해도, 상속관계, 참조관계 등 전체적인 흐름을 알아내기 어렵다.
Doxygen은 코드를 문서화하여 html 파일로 나타내어 준다. 코드만을 위한 웹 상의 문서라고 생각해도 괜찮을 거 같다. 
Doxygen을 이용하여 코드를 문서화 하면 함수 및 파일 간의 관계는 물론, 특정 규칙에 맞게 주석을 작성하면 직접 설명을 적을 수도 있다.
이번엔 앞서 언급한 기능들을 제공하는 Doxygen을 설치하는 과정을 기록한다.

 

 

1. Doxygen: Downloads 사이트에 접속하여 아래 사진처럼 본인 PC의 사양에 맞는 설치파일 다운로드!

 

2. 'I accept the agreement' 체크 후 [Next] 클릭!

 

3. 설치되는 경로 확인 후 [Next] -> default 상태에서 [Next] 클릭!

  - 4개의 체크 가능한 항목 중 위에서 2개만 설치해도 전혀 문제 없다.

 

4. [Next] -> [Install] 클릭!

 

5. [Next] -> [Finish] 클릭 -> 설치 완료!

 

Doxygen을 통해 문서화를 진행하면서 파일 간 혹은 함수 간 혹은 기타 여러 관계를 나타냄에 있어 유용한 SW가 있다.

GraphViz라는 프로그램을 이용해, Doxygen을 통해 문서화된 코드 내 여러 관계들을 UML 형식으로 나타낼 것이다.

관련 링크 : [Doxygen] Windows 10에 GraphViz 설치하기 (tistory.com)

cf. UML(Unified Modeling Language) : SW안에서 여러 관계를 시각적으로 보여주기 위한 도안 표기법

Doxygen을 통해서 만들어진 문서를 인터넷을 통해 다른 PC에서도 볼 수 있는 방법이 있다. Tomcat을 이용하는 방법이다. 설치 관련 링크는 아래에 있다.

[Apache Tomcat] Windows 10에 Apache Tomcat 설치하기 (tistory.com)