26

VS2010 XML 문서에서 HTML/도움말 파일을 만드는 훌륭한 도구를 찾고 있습니다. 난 그냥 예로서이 두 가지를 나열, 같은VS 2010에서 HTML/도움말 파일 생성 C# XML 문서

  • VSDocman
  • 내가 더가 확신

    • .Net documentation tool
    • 같은 일부 상용 도구를 발견했다. 또한 XML을 HTML 문서로 변환 할 수있는 간단한 XSLT 스타일 시트가 있습니다.

      무엇을 사용하고 있습니까? 아마도 애드 인 (add-in)처럼 변환을 할 수있는 무료 도구가있을 것입니다. 그냥 기본적으로 나는 도구의 두 가지 유형을 발견, 명확히하기 :

      1. 다른 대상 형식으로 XML 문서 파일을 변환하는 것들은, 이것은 내가 무엇을 찾고있다.
      2. 소스 코드에서 XML 문서 생성을 돕는 도구. 이것은 (!) 내가 찾고있는 것이 아닙니다.

      도움 주셔서 감사합니다.


      Sandcastle/SHFB 콤보가 훌륭합니다. 도움을 주신 모든 분들께 감사드립니다.

      일부 발언 :

      1. NDoc은 오래된 것으로 보인다는 마지막 업데이트 내가이를 생략 한 이유는 2005 년에서 그건입니다.
      2. 비슷한 내용의 스레드도 여기에서 찾을 수 있습니다. How to turn C# Xml Doc-Comments into something useful? 힌트를 보내 주셔서 감사합니다! http://sandcastle.codeplex.com/
      3. MsHelp2을 생성하기 위해 내가 hscomp.exe를 포함 VS 2008 SDK를 설치했다 :
      4. 내가 여기 있습니다 발견 샌드캐슬, 최신 버전에 대한 몇 가지 소스가 있습니다. 1.0 버전과 1.1 버전이 있습니다. 버전 1.0에는 컴파일러가 들어 있습니다. 자세한 내용은 HelixsoftSocial MSDN을 참조하십시오.
      5. 내 경우 생성 된 WebHelp이 Chrome에서 올바르게 작동하지 않습니다. 항상 index.html 페이지를 다시로드합니다.
      6. topic here은 네임 스페이스 정보를 sandcastle 문서에 추가하는 방법을 보여줍니다.
      7. 2012 년 11 월 업데이트 : 소규모 프로젝트의 경우 Doxygen을 사용하고 있습니다. 구성하는 것이 조금 쉬워졌습니다. XML 주석에서 문서의 작성을 허용
    +2

    가능한 복제본 [C# XML 문서 - 주석을 유용한 방법으로 바꾸는 방법?] (http://stackoverflow.com/questions/3082044/how-to-turn-c-xml-doc-comments-into-something -useful) – jgauffin

    +0

    네, 몇 가지 이유로 이걸 보지 못했습니다. 나는 도구의 일부를 확인한 후에 이것을 업데이트 할 것이다. –

    +1

    XML 문서를 읽을 수있는 API 목록에 NuDoc을 추가해도됩니까? http://kzu.to/nudoc – kzu

    답변

    19

    변환을 위해 Sandcastle을 사용하고 있습니다. & Sandcastle 도움말 프로젝트를 관리하기위한 사용자 인터페이스로 파일 작성기를 지원합니다. Sandcastle과 SHFB의 장점은 "평균"소스 코드 문서 옆에 프로그램 아키텍처, 따라야 할 패턴 또는 묶이지 않은 프로젝트에 대한 추가 개념 컨텐트와 같은 추가 정보를 추가 할 수 있다는 것입니다 프로그램의 한 클래스에 직접 연결하십시오. 이 작업은 Microsoft Authoring Schema의 도움을 받아 추가 XML 파일을 작성하여 수행 할 수 있습니다 (Visual Studio로 xml 파일로 편집 할 수 있으며 해당 스키마를 사용할 수 있습니다). MSDN을 문서화하는 것과 같은 두 도구로 시작할 수 있습니다.

    오래 전 나는 기술 측면 (xml 파일은 다양한 출력 유형으로 변환하기 위해 정보와 xslt 파일이 포함되어 있음)에서 거의 동일한 docbook을 시도했습니다. 그러나 Visual Studio에서 생성 된 XML 문서를 사용할 수있는 변환이 없었기 때문에 개념적 콘텐트의 변형은 우리에게 상당히 고통 스러웠습니다.

    +0

    Sandcastle/SHFB는 훌륭하게 작동합니다. 아래 몇 가지 발언. –

    3

    두 더 많은 무료 도구 :

    +1

    Afaik, NDoc은 .NET 2 이상을 지원하지 않습니다. 예 : generic 등을위한 문서화 – codeulike

    +0

    단순한 방문자를 구현함으로써 문서 멤버를 읽고 무언가를 생성하는 간단한 원시 API가 있습니다. NuDoc http://kzu.to/nudoc – kzu

    3

    샌드캐슬 + SHFB 좋은 콤보입니다.무료 및 HTML, chm 등을 생성합니다.