Sandcastle - 여전히 사용하기에 적합한 것인가요?아니면 대안이 있나요?[닫은]
https://stackoverflow.com/questions/986741
-
13-09-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
Russian문제
궁금해요 - 마지막 릴리스 모래성 2008년 5월에 출시되었으며 여전히 사전 출시 소프트웨어/CTP로 나열되어 있으며 EULA에 구체적으로 명시된 것처럼 더 이상 라이선스도 부여되지 않습니다.
2.학기.본 계약 기간은 2007년 9월 1일 또는 소프트웨어의 상용 출시일 중 먼저 도래하는 날짜까지입니다.
어쨌든 Sandcastle은 다소 "무거우므로" 이것이 여전히 사용하기에 적합한 것인지, 아니면 XmlDoc 문서를 생성할 수 있는 대안이 있는지 궁금합니다.(대안 = 최소한 HTML, 바람직하게는 PDF를 생성하기 위해 내 빌드에서 실행할 수 있는 것).
해결책
James Gregory가 시작한 최근 프로젝트 인 Docu를 언급 한 사람은 없으며 Dev는 FluentNhibernate에서 리드합니다.
HTML 문서를 생성하는 매우 간단하고 사용하기 쉬운 도구입니다. RDOC. Docu가 사용하므로 템플릿을 쉽게 수정할 수 있습니다 불꽃 보기 엔진으로.
여기에 있습니다 fluentnhibernate 문서 Docu와 함께 제작되었습니다.
다른 팁
Microsoft Sandcastle은 확실히 여전히 올바른 길입니다.Sandcastle의 기능 세트에 가까운 모든 것을 제공하는 주요 대안은 다음과 같습니다. NDoc, 그러나 마지막 릴리스는 훨씬 오래된 2005년 1월입니다!
기술적으로는 아직 (늦은) 출시 전 단계이지만 실제로는 상당히 안정적인 도구입니다.CodePlex의 일부로 제공되는 패치로 소수의 버그가 수정되었습니다. 샌드캐슬 스타일 프로젝트.이를 위한 뛰어난 GUI도 있습니다. Sandcastle 도움말 파일 빌더.
그러나 Sandcastle의 향후 개발에 대해서는 잘 모르겠습니다.나는 마이크로소프트가 어느 시점에서 이에 대한 작업/확장을 계속할 가능성이 있다고 생각하지만, 언제인지에 대한 소식은 없는 것 같습니다.현재로서는 .NET 라이브러리나 애플리케이션에 대한 적절한 문서를 작성하기 위한 유일하고 괜찮은 도구임이 분명합니다.물론 소규모 프로젝트/도움말 파일에 대해 더 "가벼운" 도구를 사용하여 벗어날 수도 있습니다.내가 알아차린 주요 대안은 상업적이고 Sandcastle보다 열등합니다.
수동으로 문서를 생성하거나 사용자 정의 자동화를 사용하는 것은 특정 경우에 가능할 수 있지만 소규모 프로젝트(확장 가능성이 없음)에만 해당됩니다.
내가 아는 한, Sandcastle은 여전히 유효한 선택입니다.최근에 여러 번 사용해봤는데 문제가 없었습니다.MSDN에서 이 페이지를 확인하고 다른 좋은 선택을 위해 '문서' 섹션까지 아래로 스크롤할 수 있습니다.
Noldorin이 앞에서 지적한 것처럼 Sandcastle Styles 및 Sandcastle Help File Builder (SHFB)를 사용하기 위해 필요한 샌드 캐슬을 효과적으로 사용하려면 그들은 모두 2010 년 중반에 새로운 릴리스를 가졌으므로 현재 도구입니다.
그러나 SHFB가 제공하는 깨끗하고 간단한 GUI에도 불구하고 깔끔하고 전문적인 문서 세트를 만들기 위해 고려해야 할 문제가 많이 있습니다. 내 기사 ( "Taming Sandcastle : 코드 문서화에 대한 .NET 프로그래머 안내서") 다양한 잠재적 인 함정에 대한 나의 경험을 문서화 Simple-talk.com 2010 년 9 월에 저장할 수 있습니다 너 시간, 노력, 고통 :-).
또 다른 유용한 자원 : 2010 년 10 월에 나는이 기사를 한 페이지 벽면 차트 SHFB에 대한 XML 문서 주석 사전이 요약되어 있습니다.
docproject 살펴볼 가치가 있습니다. 그것은 Sandcastle과 함께 일하는 많은 고통을 빼앗아갑니다.
이 질문에 일부 문서 도구의 짧은 목록을 작성했습니다.누구나 사용하는 ndoc 또는 similar-tool
Sandcastle은 현재 .NET 프로젝트를 문서화하는 데있어 최고의 OpenSource 도구라고 생각하지만 몇 가지 상용 도구가 있으며 더 나은 성능과 기능을 제안 할 수 있으므로 그 중 하나에 대한 예산이 있으면 최소한 평가할 가치가 있습니다. 당신에게 가져올 수있는 가치.
