Sandcastle로 API 문서를 생성하기위한 좋은 빠른 시작 안내서가 있습니까?
https://stackoverflow.com/questions/1229149
-
22-07-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
Russian문제
Sandcastle을 사용하여 API 문서를 생성 할 것입니다. 웹 사이트 에서이 작업을 수행하는 방법에 대한 가이드를 찾을 수 없었습니다. 누구든지 추천 할 빠른 스타트 가이드가 있습니까?
해결책
사용하는 것이 좋습니다 SHFB (가능하다면), 그것은 정말로 더 쉽게 만듭니다. SHFB에는 문서가 제공되지만 튜토리얼없이 공통 기능을 사용할 수 있습니다.
다른 팁
나는 또한 강력한 지원입니다 SHFB, 2010 년 9 월에 Sandcastle과 SHFB에 대한 상당한 기사를 썼습니다. Taming Sandcastle : 코드 문서화에 대한 .NET 프로그래머 안내서 여기서 나는 사용 팁과 많은 잠재적 인 함정을 설명 할 수 있습니다. 2010 년 10 월에 나는 그것을 따랐다 한 페이지 벽면 차트 SHFB에 대한 XML 문서 주석 사전이 요약되어 있습니다.
이 기사에 대한 나의 연구에서, 다음은 다른 유용한 리소스의 전체 목록입니다.
- Eric Woodruff 's Sandcastle 도움말 파일 빌더 문서 (SHFB 제작자)
- C# 프로그래밍 안내서 : 문서 주석에 권장되는 태그 (MSDN)
- Wm. 에릭 브런센 XML 문서 주석 가이드 (역동 성)
- Anson Horton 's C#의 XML 문서 (Microsoft C# 컴파일러 프로그램 관리자)
어쩌면 (codeplex) 사이트를 확인할 수 있습니다. 모래성. 그러나 내 경험은 그냥 놀리는 것이 가장 좋다는 것입니다. 가장 먼저해야 할 일은 XML 파일로 주석을 생성하도록 응용 프로그램을 구성하는 것입니다 (및 코드에서 XML 주석을 사용). 이것은 프로젝트의 설정입니다.
다음으로 할 수있는 일은 관련 XML을 사용하여 어셈블리를 Sandcastle에로드하고 설정과 함께 플레이하는 것입니다 (대부분의 경우 기본 설정은 충분합니다). 대부분의 설정은 자체 문서화이거나 이름을 보면 분명합니다.
행운을 빕니다!
