2011-03-04 5 views
6

Visual Studio 2010을 사용하고 있으며 XML 주석을 사용하여 작성한대로 모든 코드를 문서화하기 시작했습니다. 필자는 잘 문서화 된 프로젝트를 가지고 있으며 Visual Studio에서 빌드를 수행 할 때 완전한 XML 문서를 작성하는 방법을 알아 냈습니다. 내 질문은 무엇입니까 서식/MSDN 같은 친절하고 사용하기 쉬운 형식으로 나타납니다 있도록 웹에서이 문서를 표시하는 가장 좋은 방법은 무엇입니까? 이 작업을 쉽게 수행 할 수있는 도구가 있습니까?웹에 표시 할 Visual Studio XML 설명서의 형식을 지정하는 방법

미리 감사드립니다.

+0

[Visual Studio에서 Javadoc 스타일 주석에 대한 HTML 문서를 생성 할 수 있습니까?] (http://stackoverflow.com/questions/1935351/does-visual-studio-have-an-option) -to-generate-html-documentation-for-javadoc-sty) – Alfabravo

답변

5

Sandcastle Help File Builder을 확인하십시오. 이것은 Sandcastle을 사용하기가 매우 쉬운 GUI 도구입니다. 시작 메뉴 -> 프로그램 파일 -> Sandcastle Help File Builder의 폴더에 설치됩니다.; 꽤 사용하기 쉽지만 엄청나게 빠르지는 않습니다.

희망 하시겠습니까?

+1

Visual Studio의 빌드 이벤트 중에 문서를 만들 수있었습니다. 이 질문에 대한 내 대답을 확인하십시오 : http://stackoverflow.com/questions/211693/generate-html-documentation-automatically-during-a-build-with-sandcastle/5200822#5200822 – Chev

+0

Repo가 Codeplex에서 [ GitHub] (https://github.com/EWSoftware/SHFB) – Jessycormier

16

체크 아웃 Sandcastle

Sandcastle은 소스 어셈블리를 반영하고 XML 설명서 주석을 선택적으로 통합하여 정확한 MSDN 스타일의 포괄적 인 문서를 생성합니다.

Wikipedia에는 샌드캐슬과 통합되는 추가 프로젝트에 대한 추가 정보와 링크가 있습니다. (사용하는 것이 훨씬 쉬워 질 것으로 보인다)


또 다른 옵션은 docu입니다 :

, 복잡한 어색하거나 사용하기 어려운 일이 아니다 닷넷에 대한 문서 생성기. Visual Studio에서 생성 된 어셈블리와 XML을 통해 docu는 단일 명령으로 전체 웹 사이트를 생성 할 수 있습니다.


세 번째 옵션은 NDoc입니다 :

NDoc은 C# 컴파일러에 의해 생성 된 .NET 어셈블리와 XML 문서 파일에서 클래스 라이브러리 문서를 생성 (또는 VB을위한 추가 기능 도구 .그물).

NDoc은 플러그 형 문서 작성자를 사용하여 MSDN 스타일 HTML 도움말 형식 (.chm), Visual Studio .NET 도움말 형식 (HTML 도움말 2) 및 MSDN 온라인 스타일 웹 페이지 등 여러 가지 형식으로 문서를 생성합니다.

+0

그게 재밌 네요, 내가 처음 만났습니다. 다소 성가신 것 같았다. 생성 된 XML 문서에서 읽지 않는다고 생각합니다. 대신 .cs 파일에서 읽습니다. 이것은 확실한 한 가지 옵션이지만, 다른 누군가에게 제시 할 다른 옵션이 있는지 알고 싶습니다. – Chev

+0

@Chevex - 몇 년 동안 왕이되었습니다 ... 나는 다른 옵션으로 내 대답을 업데이 트했습니다. – Oded

+0

나는 모래톱을 사용하고 싶지만 꽤 혼란 스럽다. 설치했는데 어디로 갔는지 명확히 알지 못합니다. GUI가 있습니까? – Chev

0

NDoc도 옵션입니다. 그러나 나는 모래 성으로 갈 것이고 그것은 내가 한 일이었습니다.

0

나는 AutoHelp

AutoHelp에서, DLL & XML의 문서 파일을 읽어 도움말 페이지를 생성하고 사용자에게 노출 @ 웹 페이지에 확인을 노출하는 오픈 소스 프로젝트를 만들었습니다. AutoHelp는 최신 웹 응용 프로그램으로 ASP.NET MVC 5, ASP.NET WebApi, TypeScript, jQuery 및 Bootstrap을 사용합니다.

관련 문제