DoxyGen

UserPreferences

1 개요

오픈소스 문서화 툴의 대명사...랄까? 소스 코드에 특정 포맷의 주석을 집어넣으면 그걸 파싱해서 참고 문서를 만들어주는 툴이다.

사실 프로젝트 문서를 생성하는 데는 도구보다는 마인드가 훨씬 중요하다만, 어쨌든 한 2년 정도 써본 결과, 그리 큰 도움이 되지 않는다는 결론에 도달했다. DoxyGen 자체의 문제라기보다는 효율성의 문제다.

개인적으로 클래스 설명, 함수/인자/리턴값 설명, 변수 설명 정도까지만 단다. 여기까지만 해도 실제 소스를 보면 최소 3 분의 1 이상이 주석이다.

하지만 이 정도로는 DoxyGen 문서를 생성해도, 같이 일하는 다른 사람에게 별로 도움이 되지 않는다. (자신에게는 어느 정도 도움이 된다.) 실제로 다른 사람에게 도움이 되려면 각각의 모듈마다 연관된 다른 모듈, 예제, 주의해야할 점 등을 모두 적어줘야 하는데, 이 정도로 적으려면, 실제로 코딩하는 시간보다 주석 적는데 들어가는 시간이 훨씬 커진다.

여러 사람이 합심하여 같이 주석을 단다면 또 모르겠지만, 자기가 짠 소스, 자기만 만지는 상황에서는 별로 추천하지 않는다.

2 목록

• DoxyGenSyntax - 자주 사용하는 주석 포맷
  
• DoxyGenSetup - Doxyfile을 설정 및 배치 파일을 이용한 문서 생성
  
• DoxyGenSetupForVisualCpp - VisualCpp 2005 솔루션 파일을 이용하여 독시젠 설정 파일 생성하기
  
  
  

3 링크

• http://www.doxygen.org
  
DoxyGen 프로젝트 홈페이지

• Doxygen Configuration File Syntax
  
DoxyGen 설정 파일 문법

• 10 Minutes to document your code
  
VisualCpp + DoxyGen 간단 개요

4 다운로드

• doxygen.css
  
폰트 크기를 줄인 CSS 파일. 적당한 곳에다 복사하고, 설정 파일의 HTML_STYLESHEET 필드에다 경로를 적어주자. 하는 김에 색깔도 좀 손볼까나...


HTML_STYLESHEET = "C:\Program Files\doxygen\doxygen.css" 

• CategoryTools