스페이스 인터내셔널(주) 블로그

안녕하세요.  뇽이 입니다 ^^
얼마전에 Effective Java란 책을 보던중에 JavaDoc관련 내용을 읽었었는데요.
(제가 Java개발자는 아니지만 언어와는 별개로 많은 것을 배울수있는 책이네요.)
이게 자극이 되서 doxygen과 graphviz를 설치해서 사용하고 있습니다.ㅎ (역시 책을 읽어야 되나 봅니다)
아마도 소프트웨어 개발에 종사하시는 분이라면 doxygen이나 JavaDoc같은 툴을 써보지 않았더래도 많이 들어보셨을 것 같아요.
이 툴들을 이용해서 문서화하는걸 저희 회사 다른직원분께서 강의를 해주신게 있어서 수월하게 작업할 수 있었네요(상민씨 고마워요ㅋ)
암튼 이 도구들은 잘만 사용하면 참 좋은 도구인데 저를 포함한 많은 개발자들이 귀찮아서 못하는것 같아요.
문서화 주석을 형식에 맞춰서 쓰기가 상당히 귀찮고 힘든데요.
다행히 이를 해결해줄 수있는 좋은 Visual Studio Add-in프로그램이 있더라구요.
DoxyComment 란 Add-in인데요. VS 2005, VS 2008 을 지원한답니다.
VC 6쓰시는분은 DocBar를 쓰시면 될 것같구요.(혹시 아직도 VC6쓰시나요? 업그래이드하시죠^^ㅎ)

DoxyComment는 소스코드편집기에서 문서화주석을 달아주는 아주 고마운 도구랍니다
설치방법이나 사용법은 아주 간단해요.
설치하실때는 "Next"만 잘 눌러주시면 되고요.
설치가 완료되면 Visual Studio에 툴바가 하나 생깁니다.
신기하게 한글을 지원해주더라구요. "코드주석추가", "파일주석추가" 버튼이 있는 툴바가 있는데요. 이 버튼을 누르면 이쁜 문서화주석을 만들어줍니다
"파일주석추가"는 소스편집기 어디서든지 누르시면 파일의 맨 위 라인에 추가가 되고요
"코드 주석 추가"는 클래스명이라던가 함수명에 커서가 있어야 제대로 만들어 줍니다.
몇번 해보시면 금방 아실 수 있을꺼에요.


DoxyComment를 다운로드할 수있는 링크입니다.
http://doxycomment.sourceforge.net/vs2005_addin.html

Graphviz 링크
http://www.graphviz.org

독시즌 링크
http://www.doxygen.org


doxygen 과 Graphviz 연동방법은 이미 많은 블로그들이나 웹사이트에 자료가 많이 있어서 생략하겠습니다.
혹시라도 궁금하신분 계시면 메일주시고요. (제가 잘 알진 못하지만 아는 범위내에서 알려드릴께^^);

(0) (0)