.Net XML 주석을 API 문서에 추가

문제

Visual Studio XML 출력에서 MSDN 스타일 문서를 생성하는 쉬운 방법이 있습니까?
나는 이 다리를 건너는 첫 번째 사람이 아니라는 것을 알기 때문에 좋은 xslt를 설정할 만큼 인내심이 없습니다.

그리고 최근에는 모래성 설치도 해봤는데 정말 눈이 번쩍 뜨이더라구요.그 과정에서 중요한 것을 놓치고 있거나 너무 복잡해서요.

나는 누군가가 정말 훌륭하고 매우 간단한 해결책을 가지고 있다는 것을 알고 있습니다.

내 서식으로 인해 해당 단락이 읽기에 적합하지 않다고 생각했기 때문에 여기서 다시 반복합니다.

샌드캐슬을 시도해 보았지만 설정하는 데 정말 어려움을 겪었습니다.제가 실제로 염두에 두고 있는 것은 훨씬 더 간단한 것입니다.

즉, 제가 모래성 과정을 이해하지 못하는 한 말이죠.테스터들이 작업할 수 있는 좋은 것을 만드는 것만으로도 나에게는 엄청난 추가 짐처럼 보였습니다.

해결책

샌드캐슬을 찾고 계시나요?

프로젝트 페이지: 샌드캐슬 출시

.NET용 NDoc 코드 문서 생성기 예전에는 선택 도구였지만 지원은 거의 중단되었습니다.

다른 팁

보세요 모래성, 정확히 그 일을합니다.또한 가장 간단한 솔루션 중 하나이며 선택하는 도구이므로 장기적으로 설정 중에 발생한 문제를 지정하면 Sandcastle을 설정하는 데 도움을 줄 수 있습니까?

또한 Sandcastle 도움말 파일 빌더를 사용해야 합니다.도움말 파일을 생성하기 위한 GUI와 같은 ndoc를 제공하므로 명령 프롬프트에서 아무 것도 할 필요가 없습니다.

따르다 이 간단한 5단계 기사 그리고 당신은 거의 끝났습니다.보너스로 사용할 수 있습니다 H2뷰어 HTML 도움말 2.x 파일을 보려면

방금 샌드캐슬을 다시 설정했습니다.설치(2008년 5월 릴리스)를 시도하고 SandcastleGui.exe 또는 유사한 항목(예제 폴더 정도에 있음)을 검색해 보십시오.

어셈블리 추가를 클릭하고 어셈블리를 추가하고 .xml 문서 파일(해당 옵션을 활성화한 경우 컴파일러에서 생성된 파일)을 추가한 다음 빌드합니다.

시간은 좀 걸리겠지만 결과는 ~ 할 것이다 노력할 가치가 있습니다.실제로 MSDN에서 항목을 검색하므로 결과 문서에는 MSDN 및 항목에 대한 링크가 포함된 System.Object까지 클래스 상속도 포함됩니다.

Sandcastle은 처음에는 다소 복잡해 보입니다. 특히 자동화된 빌드에서 사용하려는 경우에는 더욱 그렇습니다. 그러나 노력할만한 가치가 있을 것이라고 확신합니다.

또한 살펴보십시오. Sandcastle 도움말 파일 빌더, 이것은 좀 더 발전된 GUI입니다.

나는 사용한다 NDoc3

라이센스 : CC-BY-SA ~와 함께 속성

제휴하지 않습니다 StackOverflow