Visual studio를 이용하여 프로젝트마치고 나서 귀찮은 문서화의 수고를 덜기위해 한번쯤 사용해 볼만한 툴이다.
문서화를 지원하는 건 여러가지 프로그램들이 있다.
그 중에서 SandCastle에 대해 간단 버전으로...
1. GhostDoc을 설치한다.
2. VS2005를 실행하면 단축키 지정 등의 셋팅을 물어보며 GhostDoc이 AddOn으로 자리를 잡는다.
3. 실행할 프로젝트를 읽어온 후,
4. GhostDoc의 환경 잡아주고 나서 메뉴 : 프로젝트 -> 속성 -> 빌드 : 출력 : XML 체크
5. 빌드한다.
6. XML 출력이 생성된다.
7. SandCastle Help File Builder를 실행시킨 후, 화면의 ADD 버튼을 클릭하여 생성된 XML을 찾아 지정한다.
8. 도구바에 있는 컴파일 버튼을 클릭한다.
9. SandCastle Help File Builder 혼자 열심히 돈다. 잠시 혼자만의 시간을 갖자. =-=;;
10. 아.. 위에서 OutputPath로 지정된 곳에 chm 파일이 생긴다.
프로그램 다운로드 정보.
======================
XML 작성 도구 : GhostDoc
설명 :
<summary>
GhostDoc is a free add-in for Visual Studio that automatically generates XML
documentation comments for C#. Either by using existing documentation inherited
from base classes or implemented interfaces, or by deducing comments from
name and type of e.g. methods, properties or parameters.
</summary>
GhostDoc is a free add-in for Visual Studio that automatically generates XML
documentation comments for C#. Either by using existing documentation inherited
from base classes or implemented interfaces, or by deducing comments from
name and type of e.g. methods, properties or parameters.
</summary>
다운로드 : http://shfb.codeplex.com/
주요 목적 : Visual Studio 2003 이상의 버전에서 XML로 작성된 태그 및 내용을 읽어들여 하나의 XML파일로 저장한다.
도움말을 작성 도구 : Sandcastle - Documentation Compiler for Managed Class Libraries
설명 :
도움말 파일을 작성하는데 필요한 ClassLibrary 와 실행파일.