모든 ms xml 설명서 태그로 모든 코드에 주석을 달았습니다. 주석 처리 된 코드 모두에 대해 HTML 전용 (또는 pdf) 문서를 생성하려면 어떻게합니까? sandcastle을 다운로드했지만 다음 단계로 이동하는 방법을 알 수 없습니다. 감사!aspdotnet 웹 프로젝트에서 HTML 전용 설명서를 생성하려면 어떻게합니까?
답변
당신은 http://ndoc.sourceforge.net/
기본적으로 ndoc 볼 수, 프로젝트의 속성에서 당신은 XML 문서에 설정해야합니다. 프로젝트를 마우스 오른쪽 버튼으로 클릭하고 속성을 선택한 다음 빌드 탭으로 이동하고 XMLDocumentation 확인란을 선택합니다.
이것은 html이 아닌 xml 파일을 생성합니다. 그런 다음 XSLT 스타일 시트를 사용하여 xml 파일을 변환 (또는 구문 분석)해야합니다. 바로 nDoc이 그것입니다.
샌드캐슬 (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# 컴파일러 프로그램 관리자)
- 1. 기존 웹 페이지에서 CHM을 생성하려면 어떻게합니까?
- 2. JavaScript를 사용하여 임의로 HTML 16 진수 색상 코드를 생성하려면 어떻게합니까?
- 3. 여러 암호에서 공통 해시를 생성하려면 어떻게합니까?
- 4. SSIS를 사용하여 기본 키를 생성하려면 어떻게합니까?
- 5. WiX에서 64 비트 MSI를 생성하려면 어떻게합니까?
- 6. 75 - 100 % 사이의 숫자를 임의로 생성하려면 어떻게합니까?
- 7. VS 2005 및 2008에서 HTML API 설명서를 생성하는 방법은 무엇입니까?
- 8. HTTP 프로토콜 : HTML 전용?
- 9. 유니버설 프로젝트에서 iPhone 전용 카테고리를 추가하는 방법
- 10. 프로젝트에서 불필요한 리소스를 제거하려면 어떻게합니까?
- 11. 웹 설치 프로젝트에서 새 응용 프로그램 풀을 만들려면 어떻게합니까?
- 12. 설명서를 볼 수 있습니까?
- 13. wkhtmltopdf에서 선택 가능하고 검색 가능한 텍스트로 PDF를 생성하려면 어떻게합니까?
- 14. html 및 css 전용 : 다른 페이지에서 html 태그 재사용
- 15. .Net의 SOAP/WebService 클래스에 대한 HTML 문서를 생성하려면 어떻게해야합니까?
- 16. Flash CS3 AS3 프로젝트에서 웹 서비스에 액세스
- 17. ASP.NET 프로젝트에서 중복 된 HTML
- 18. 설명서를 생성하는 Diff 도구는 무엇입니까?
- 19. iPhone 앱의 템플릿을 기반으로 SMS 메시지를 생성하려면 어떻게합니까?
- 20. 필드를 결합하여 등록하는 동안 사용자 이름을 생성하려면 어떻게합니까?
- 21. C# 소스 코드에 COM interop 프록시를 생성하려면 어떻게합니까?
- 22. Ant를 사용하여 Emma code coverage 보고서를 생성하려면 어떻게합니까?
- 23. texi2dvi 또는 TeX가 설치되지 않은 상태에서 R로 보고서를 생성하려면 어떻게합니까?
- 24. 미디어 파일에 대한 코덱을 사용하여 콘텐츠 형식 문자열을 생성하려면 어떻게합니까?
- 25. 내 신문 사이트에 대해 "관련 기사"를 자동으로 생성하려면 어떻게합니까?
- 26. CMake 빌드 대상에서 오브젝트 파일 (* .o) 만 생성하려면 어떻게합니까?
- 27. 목록 (ul) 태그에서 항목의 배열을 생성하려면 어떻게합니까? 다음 코드에서
- 28. SVNindex.cmd를 사용하여 Srcsrv를 extern 파일의 색인을 생성하려면 어떻게합니까?
- 29. 솔루션 구축시 MSBuild Task에서 XML 문서를 생성하려면 어떻게합니까?
- 30. iPhone 개발을위한 새로운 공용/개인 키 쌍을 생성하려면 어떻게합니까?