DocProject vs Sandcastle 도움말 파일 Builder Gui
https://stackoverflow.com/questions/319632
-
11-07-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
Russian문제
함께 문서화하려는 일부 내부 라이브러리 구성 요소와 함께 여러 C# 프로젝트가 있습니다. Sandcastle은 C#에서 문서를 생성하기 위해가는 곳 인 것 같습니다. DocProject 또는 Sandcastle 도움말 파일 빌더 GUI 중 어느 것이 더 좋고 필요한 기능을 지원하는 두 가지 중 어느 것이 알고 싶습니다.
각 프로젝트 자체의 문서 부분 만 컴파일 한 다음 결국에는 모두 함께 통합하도록합니다. (즉, 하나의 문서 프로젝트의 라이브러리 구성 요소와 자체 문서 프로젝트의 각 프로젝트, Help 2 Viewer를 사용하여 단일 루트로 위의 모든 프로젝트)
해결책
Sandcastle 도움말 파일 빌더를 보증 할 수 있습니다. 정말 잘 작동하며 Sandcastle 도움말 파일 빌더 프로젝트 내에 여러 어셈블리를 문서화 할 수 있습니다. 이론적으로, 당신은 빌더 프로젝트를 가지고 각 C# 프로젝트에 대해 문서를 생성 한 다음 모든 것을 문서화하는 마스터 빌더 프로젝트를 가질 수 있습니다.
다른 팁
다음은 Sandcastle 기반 .NET 문서에 대한 유용한 링크입니다.
Sandcastle 도움말 파일 빌더 (SHFB)
SHFB 튜토리얼
웹 프로젝트 문서
웹 프로젝트를 문서화하는 방법에 대한 튜토리얼 (더 많은 매뉴얼과 나는 이전에 링크를 고려할 때 구식을 믿는다)
나는 docproject를 사용하지 않았지만 Sandcastle과 비슷한 기능을 갖춘 제품처럼 보입니다.
나는 사용했다 모래성 그리고 나는 그것이 효과적인 도구라고 생각합니다. 당신은 또한 필요합니다 Sandcastle 도움말 파일 빌더 (SHFB) 다른 사람들이 여기서 언급했듯이 좋은 프론트 엔드를 제공합니다. 또한 필요합니다 샌드 캐스트 스타일 샌드 캐슬 엔진에 대한 프리젠 테이션 레이어 패치. 이 세 가지 구성 요소 모두 2010 년 중반에 새로운 릴리스가 있었지만 Firefox 3.6의 렌더링 결함으로 인해 2008 년 릴리스에서 업그레이드를 연기하고 있습니다 (2010.09.06에 문서화되어 있습니다. 결함 보고서).
나는 그 문제를 설명하는 플랫폼에 대한 나의 경험과 깔끔하고 전문적인 문서 세트를 만들기 위해 당신이 필요하거나 고려해야 할 다양한 다른 사람들을 철저히 문서화했습니다. 내 기사 "Taming Sandcastle : 코드 문서화에 대한 .NET 프로그래머 안내서"방금 출판되었습니다 Simple-talk.com 2010 년 9 월; 저장할 수 있습니다 너 시간, 노력, 고통 :-).
DOC 프로젝트는 더욱 세련된 문서를 생성합니다. 훨씬 더 화려한 제품입니다.
Sandcastle 도움말 파일 빌더는 견고하고 작업을 완료합니다.
