class library 의 documentation 생성
1.
/// 를 치면 VS 가 알아서 xml comment 를 삽입해준다.
http://msdn.microsoft.com/en-us/library/b2s063f7.aspx
에 관련된 내용이 나와있다.
링크를 타서 가보면 http://msdn.microsoft.com/en-us/library/5ast78ax.aspx 가 보인다.
2.
프로젝트 속성에서 xml document 파일을 생성하도록 설정하자.
VS 2010 기준으로 위와 같이 생겼다.
자 이제 빌드를 하면 저 경로에 xml document 파일이 생긴다.
3.xml 파일을 유용한 다른 것 ( html, chm 등 ) 으로 변환하기.
freeware가 많이 있는데 나는 Sandcastle 을 택했다.
요기서 다운로드 받고 설치하면 된다.
우리가 사용할 것은 SHFB(Sandcastle Help File Builder) 인데, GUI를 제공한다.
적당히 알아서 다 깔았으면
C:\Program Files\EWSoftware\Sandcastle Help File Builder
대충 이런 경로를 찾아가서 SHFB 를 실행한다.
그다음 SHFB 에서 새로운 프로젝트를 만들어주고
우측에 Project Explorer 에서 Documentation Sources 를 우클릭해서 xml 파일을 추가해주면 알아서 필요한 파일(dll 등)을 추가해준다.
자 이제 Project Properties 탭으로 가보자.
Help File을 에 타이틀 등을 적절히 설정하고
Paths 에서 경로 설정을 하고
Visibility 에서 어떤 메소드가 노출될것인지 설정하자.
이제 위에 Build 버튼을 누르면 빌드가 시작된다. 시간이 좀 걸린다.
결과물로 chm ( compiled html ) 파일을 얻을 수 있다.
참고로 VS에 add-in 으로 붙여서 쓸 수 있는 것도 있다.
http://www.helixoft.com/vsdocman/overview.html
근데 얘는 상용SW다.