TJStory | 열정 그 이야기..

이하 내용에 대한 문서를 복사 , 링크 하실경우에 댓글을 남겨주세요 ^^*

닷넷 자동 문서화에 대해 알아보던중 SandCastle, GhostDoc 를 발견했네요..

Tool 들의 설치

환경 : vs2008, vista

SandCastle : Xml 태그를 Help 파일로 변환해 주는 툴, MS 에서 지원하고 MSDN 이 이를 이용하여 제작되었다고 합니다
홈페이지 : http://www.codeplex.com/Sandcastle
컴파일러 다운로드 : http://www.codeplex.com/Sandcastle/Release/ProjectReleases.aspx?ReleaseId=9921
Gui 빌더 다운로드 : http://www.codeplex.com/SHFB/Release/ProjectReleases.aspx?ReleaseId=9848
SandCastle, Sandcastle Help File Builder Installer 라는 파일만 다운로드 하시면 될듯..

GhostDoc : Xml 태그 주석을 입력하는 툴
vs 2008 버젼 다운로드 : http://www.roland-weigelt.de/ghostdoc/

SandCastle 컴파일러와 gui 버젼을 다운로드 한후 설치.. GhostDoc 를 설치합니다.
SandCastle 버젼 :  Sandcastle January 2008 Release
SandCastle GUI 버젼 : 1.6.0.4 Production
GhostDoc 버젼 : GhostDoc Version 2.1.3 for Visual Studio 2008

GhostDoc 를 설치하니 VS2008을 실행 단계에서 단축키 설정을 할 수 있도록 되어있군요..
단축키를 설치하여도 되고.. 안하여도 VS2008 팝업 메뉴에 XML 태그를 입력할 수 있는 메뉴가 보이네요..

1. 우선 테스트 삼아 프로젝트를 생성한후, 소스 상에서 XML 주석을 달아 줍니다.
GhostDoc를 설치하셨다면 팝업메뉴에서 확인이 가능하죠. ^^

2. 프로젝트 프로퍼티에 >> 빌드 >> 이곳에서 XML documention  옵션을 체크 해주셔야 xml 문서를 생성하실 수 있습니다.
이옵션을 체크하고 프로젝트를 빌드하면 프로젝트 폴더에 XML 파일이 생성된 것을 확인하실 수 있습니다.

3. SandCastle HelpBuilder 를 실행시키고, 생성된 Xml 파일을 Add 시킵니다.
여기서 한가지 주의 해야 할 점은.. SandCastle이 Xml 파일과 프로젝트 빌드로 만들어진 결과물(Exe, Dll)에 대한 정보 또한 필요로 한다는 점입니다.
프로젝트 생성과정에서 결과물이 생성되는 폴더에 대한 옵션을 건드리지 않았다면 XML 애드만 시켜주시면 자동적으로 연결이 되는데요..

만약 OutPut 폴더를 다른 곳으로 걸어주셨을경우에는 우선 XML 을 애드 한후,
SandCastle 의 Edit 버튼을 누르시고   AssemblyPath 에서 아웃풀 경로를 적어주셔야 합니다. ^^*

빌드를 수행하시면 MSDN 과 같은 헬프 파일을 보실 수 있습니다.

SandCastle 옵션 설정

귀찮은 관계로 기본 옵션을 사용하기로 했습니다만..
상속된 요소들까지 헬프파일에 포함을 시켰더니 용량또한 늘어나고 빌드 시간 또한 길어지는군요..
이부분을 False 처리해주었습니다.

그리고 위 메뉴중 Help File >> Language 탭에 가보시면 한국어 또한 ^^*
GhostDoc Xml 주석달기
소스 코드 상에서 마우스 우클릭 Document this 메뉴를 클릭해보면..
함수를 예로 들경우.. 아래와 같이 자동 주석이 달리는 군요..

Tests the function << 이부분에 함수에 대한 요약을 적어 주고..
보시면 파라미터 에 대한 주석과 리턴 값에 대한 주석 또한 달아 줄 수 있습니다.

또한 함수가 아닌 클래스에 대한 정보라던지 변수에 대한 정보 또한 표현이 가능하네요..

테스트를 사내 소스로 해봤더니 공개 하기가 그르네요.. ㅎㅎ;;
완성품의 일부만 봐볼까요 ^^;;