Doxygen (문서화 툴)

개발 2009. 7. 20. 03:17


프로젝트 소스 문서화 툴이다...

독시젠 : http://www.stack.nl/~dimitri/doxygen/

클래스 계층도 또는 함수 호출관계를 그림으로 표시하려면 Graphviz를 설치해야 한다.

그래프비즈 : http://www.graphviz.org/

Doxygen이 GUI 모드를 제공하므로 편리하다.

주석은 독시젠 타입으로 작성한다.
주석타입을 지키는건 귀찮은데 다행히 doxycomment라는 Add-in이 있다.
기본 Comment Provider는 별 쓸모가 없다.

오픈소스를 받아서 커스터마이징해서 쓰자.
SVN으로 소스를 받도록 한다. 사용법은 생락한다.
SVN URL: http://commentplus.googlecode.com/svn/trunk
솔루션을 열면 TestProvider 프로젝트가 있다. TestProvider.cs파일을 수정하면 된다.
첨부파일을 참고한다.

빌드하면 솔루션 bin폴더의 Custom Providers폴더에 TestProvider.dll 파일이 생성된다.

이파일을 아래경로에 복사한다. 
vs2005용을 설치한 경우: C:\Program Files\SourceForge.net\DoxyComment add-in for Visual Studio 2005\Custom Providers

1.6.1을 기준으로 한글을 출력하는데 문제가 발생하면 다음과 같이 처리한다.

Input -> INPUT_ENCODING CP949로 변경

본인의 경우, 클래스를 전처리문으로 처리한 경우, (#ifdef ~#else ~ #endif) 오류가 발생했는데 아래와 같이처리했다.
Preprocessor -> ENABLE_PREPROCESSING, MACRO_EXPANSION

Graphviz 연동
Expert -> Dot -> DOT_PATH 를 설정한다.
Expert-> Dot -> HAVE_DOT 체크

'개발' 카테고리의 다른 글

Java ArrayList Shallow copy vs Deep copy  (0) 2021.01.27
Posted by Lumasca
,