2007.12.25 02:15

C#소스의 문서화

.NET 2007.12.25 02:15

C# 소스를 문서화 하기 위한 툴은 여러개 있는 것 처럼 보이지만 막상 사용하려고 하면
생각만큼 선택의 여지는 넓지 않습니다.
닷넷채널 프레임웍의 도움말을 만들기 위해서 소스상의 주석을 가지고 문서화를 할 수 있는
방법들을 찾아 보았습니다.

우선 대부분의 문서툴에서는 Visual Studio에서 지원하고 있는 xml 포멧을 사용합니다.
Visual Studio에서는 주석문으로 잘 달아놓은 것들을 XML포멧으로 출력하는 기능을 가지고 있습니다.

사용자 삽입 이미지

<그림1> 솔류션 탐색기에서 속성을 선택
사용자 삽입 이미지
<그림2>XML문서 파일 출력 설정
사용자 삽입 이미지

<그림3>출력된 XML파일

<그림1~3>을 참조하면 Visual Studio 에서 주석문을 정리한 XML파일을 얻을 수 있습니다.
사용자 삽입 이미지
<그림4>XML파일의 내용
이 XML 파일을 가지고 대부분 문서를 생성할 수 있게 지원하는데
이전까지는 대표적으로 많이 사용했던 것이 바로 NDoc 입니다.
사용자 삽입 이미지
<그림5>NDoc 사이트

하지만 NDoc은 그 뛰어난 기능에 비해서 오픈소스 프로젝트의 한계인 참여율 저조를
극복하지 못하고 개발이 중단되었습니다. 그래서 닷넷프레임웍 2.0을 지원하지 못합니다.
사용자 삽입 이미지
<그림6>NDoc설치화면
사용자 삽입 이미지
<그림7>NDoc의 지원 프레임웍
그래서 두번째로 선택할 수 있는 것이 바로 Doxygen이라는 프로그램입니다.
이 프로그램은 사용하기가 생각보다 까다롭고 불편해서 일단은 사용 불가로 생각했습니다.
사용자 삽입 이미지
<그림8>한 블로그에서 소개하고 있는 Doxygen
사용자 삽입 이미지
<그림9>Doxygen 공식 사이트
사용자 삽입 이미지
<그림10>Doxygen 다운로드
사용자 삽입 이미지
<그림11>Doxygen 설치
사용자 삽입 이미지
<그림12>Graphviz 설치

결국 제가 선택한 툴은 Sandcastle입니다.
강력하면서도 적절한 툴이며 프레임웍도 2.0을 잘 지원하고 있습니다.

사용자 삽입 이미지
<그림13>Sandcastle의 설치
Sandcastle는 UI가 없습니다. 그냥 명령어 기반의 프로그램입니다. 때문에 좀더 원활하게
사용하기 위해서는 Sandcastle Help File Builder가 함께 필요합니다.

사용자 삽입 이미지
<그림14> Sandcastle Help File Builder
사용하는 방법은 아주 쉽기 때문에 일단 패스 합니다. ^^

신고


티스토리 툴바