4
모든 ms xml 설명서 태그로 모든 코드에 주석을 달았습니다. 주석 처리 된 코드 모두에 대해 HTML 전용 (또는 pdf) 문서를 생성하려면 어떻게합니까? sandcastle을 다운로드했지만 다음 단계로 이동하는 방법을 알 수 없습니다. 감사!aspdotnet 웹 프로젝트에서 HTML 전용 설명서를 생성하려면 어떻게합니까?
A
답변
5
당신은 http://ndoc.sourceforge.net/
기본적으로 ndoc 볼 수, 프로젝트의 속성에서 당신은 XML 문서에 설정해야합니다. 프로젝트를 마우스 오른쪽 버튼으로 클릭하고 속성을 선택한 다음 빌드 탭으로 이동하고 XMLDocumentation 확인란을 선택합니다.
이것은 html이 아닌 xml 파일을 생성합니다. 그런 다음 XSLT 스타일 시트를 사용하여 xml 파일을 변환 (또는 구문 분석)해야합니다. 바로 nDoc이 그것입니다.
2
샌드캐슬 (ndoc 후속)이 우수한 서 공구 그러나 아이러니하게도 쉽게 사용 경로이고 효과적으로 잘 문서화 아니다. Sandcastle에 직접 액세스하지 말고 Sandcastle Help File Builder (SHFB) 또는 이와 유사한 플랫폼을 사용해야합니다. (태양을 생각해보십시오. 주위를 둘러 보는 것은 좋지만, 강한 선글라스 없이는 직접보고 싶지는 않습니다 :-) 질문은 SHFB을 사용하는 방법이됩니까?
내 2010 년 9 월호 Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code에는해야 할 일에 대해 자세히 설명하고 발생할 가능성이있는 많은 함정을 지적합니다. 2010 년 10 월에 나는 SHFB에 대한 XML 문서 주석 어휘를 요약 한 one-page wall chart을 사용했다.
- 에릭 우드 럽의 Sandcastle Help File Builder Documentation (SHFB 크리에이터)
- C# 프로그래밍 가이드 : Recommended Tags for Documentation Comments (MSDN)
- WM 기사에 대한 내 연구에서
, 여기에 다른 유용한 자원의 전체 목록입니다. 에릭 Brunsen의 XML Documentation Comments Guide (Dynicity)
- 베어 호튼의 XML Documentation in C# (마이크로 소프트 C# 컴파일러 프로그램 관리자)