Doxygen을 이용해서 코드에 설명을 달고 코드 자체를 문서화 하려고 했다. 하지만 주석을 달다보면 생각보다 번거롭다. Visual Studio에는 이러한 번거로움을 덜어주는 Plug-In이 있다. 오늘은 Doxygen 주석을 좀 더 편하게 다는 방법에 대해 기록한다. Doxygen 설치하기 : [Doxygen] Windows 10에 Doxygen 설치하기 (tistory.com) 1. Visual Studio를 실행한 후 상단의 [확장] 탭에서 '확장 관리' 클릭! 2. 우측 상단의 검색 창에 'doxygen'을 검색하면 나오는 Doxygen Comments'를 다운로드! 3. 다운로드가 완료되면 하단의 메시지를 따라 우측 하단의 '닫기' 클릭! 4. 로딩이 완료된 후 아래의 창에서 'Modify' ..

GraphViz 프로그램을 설치할 때와 마찬가지로 Doxygen을 이용하다가 알게 된 프로그램이다.(정확히는 동기를 통해 알게됐지만..) Apache Tomcat 프로그램을 이용하면 PC A에 있는 html 파일을 PC B에서도 인터넷을 통해 볼 수 있게 된다. 당연히 인터넷이 되는 다른 모든 PC에서 볼 수 있다.(방화벽이 막혀 있지 않다면....) 앞서 말했듯 html파일에 대한 접근성을 높여 주는 Apache Tomcat을 설치하며 과정을 기록한다. 사전 준비사항 - JDK(혹은 JRE) 설치필요 [Windows 10] Java Development Kit 8.0 설치하기 (tistory.com) 1. https://tomcat.apache.org/download-10.cgi 사이트 접속 후 본인 ..

나는 Doxygen을 사용하기 위해 알아보던 중 'GraphViz'라는 프로그램을 알게 되었다. 이 프로그램은 dot이라는 그래프 서술 언어를 이용하여 다이어그램을 그려준다. 여기에서는 Doxygen의 결과로 나올 문서의 수준을 높여주기 위해 GraphViz를 설치하는 과정을 기록한다. 1. Download | Graphviz 사이트에 접속 후 본인 PC의 사양에 맞는 설치파일 다운로드! 2. [다음] -> [동의함] 클릭! 3. 'Add Graphviz to the system PATH for all users' 체크 후 [다음] -> 설치되는 경로 확인 후 [다음] 클릭! - Doxygen을 위해 설치하는 거라면 환경변수 PATH에 추가할 필요는 없다. 4. [설치] -> [마침] -> 설치완료!

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