C# 코드용 html 문서 만들기

C# 코드용 html 문서 만들기

---

저는 현재 C# 프로젝트에서 작업 중이며 VisualAssist /// <summary></summary>가 저를 위해 이러한 멋진 주석을 생성 하고 저는 그것들을 사용하여 제 코드를 문서화하고 있습니다.

Doxygen 또는 Javadoc에서 수행한 것과 같은 HTML 문서를 작성하기 위해 이러한 주석을 사용하는 방법이 있어야 한다고 가정합니다. 어떻게 해야 하나요?

---

Doxygen 또는 Sandcastle 도움말 파일 빌더 는 XML 문서를 외부 문서의 HTML(및 기타 형식)로 추출하는 기본 도구입니다.

이러한 문서 내보내기 도구를 문서 생성기와 결합할 수 있다는 점에 유의하십시오. Resharper에는 몇 가지 기본적인 도우미가 있지만 GhostDoc (XML 문서가 있는 C#/VB 코드용 ) 또는 내 애드인 Atomineer Pro 문서 (C#, C++/CLI, C++, C, VB, Java, JavaScript, TypeScript, JScript, PHP, XML, Doxygen, JavaDoc 또는 Qt 문서를 포함하는 Unrealscript 코드용).

---

2017 년, 자바 독 것 아마에 일이 가장 가까운 DocFx Microsoft에서 개발하고 Section 명령 - 라인 도구뿐만 아니라 VS2017 플러그인으로 제공되었다.

가장자리 주변이 여전히 약간 거칠지만 유망해 보입니다.

또 다른 대안은 네트 애플리케이션에 적합한 문서 레시피가 있는 Wyam 입니다. 상기 봐 케이크 문서 에 대한 예.

---

이 페이지가 흥미로울 수 있습니다. http://msdn.microsoft.com/en-us/magazine/dd722812.aspx

명령줄 컴파일러를 사용하거나 Visual Studio 인터페이스를 통해 XML 문서 파일을 생성할 수 있습니다. 명령줄 컴파일러로 컴파일하는 경우 /doc 또는 /doc+ 옵션을 사용합니다. 그러면 어셈블리와 동일한 이름 및 동일한 경로에 XML 파일이 생성됩니다. 다른 파일 이름을 지정하려면 /doc:file을 사용하십시오.

Visual Studio 인터페이스를 사용하는 경우 XML 문서 파일 생성 여부를 제어하는 ​​설정이 있습니다. 설정하려면 솔루션 탐색기에서 내 프로젝트를 두 번 클릭하여 프로젝트 디자이너를 엽니다. 컴파일 탭으로 이동합니다. 창 하단에서 "XML 문서 파일 생성"을 찾아 선택되어 있는지 확인합니다. 기본적으로 이 설정은 켜져 있습니다. 어셈블리와 동일한 이름과 경로를 사용하여 XML 파일을 생성합니다.

---

Visual Studio에 대한 위의 방법은 Visual Studio 2013에 적용되지 않는 것 같았지만 프로젝트 메뉴를 사용하여 설명된 확인란을 찾고 내 프로젝트(하위 메뉴의 마지막 항목)를 선택하여 대화 상자에 액세스할 수 있었습니다. 확인란(빌드 탭에서).

참조URL : https://stackoverflow.com/questions/15316381/create-html-documentation-for-c-sharp-code