2010-05-15 4 views
8

Visual Studio에서 코드에 대한 설명서에서 읽을 수있는 문서 파일을 직접 생성 할 수 있습니까?CHM 또는 HTML 파일에 C# 문서를 생성하는 방법은 무엇입니까?

/// <summary> 
/// Convert a number to string 
/// </summary> 
/// <param name="number">An integer number to be converted to string</param> 
/// <returns>Number as string</returns> 
/// <example> 
/// <code> 
///  var s = MyMethod(5); 
/// </code> 
/// </example> 
/// <exception cref="Exception">In case it can't convert</exception> 
/// <remarks> 
/// Whatever 
/// </remarks> 
public string MyMethod(int number) 
{ 
    return number.ToString(); 
} 

답변

4

VSdocman 비주얼 스튜디오에서 직접 할 수 있습니다.

+1

훌륭한 도구! Visual Studio 2010에서 이미 작동하며 사용법이 간단하고 훌륭한 문서를 생성 할 수 있습니다. – BrunoLM

9

사용 DocProject :

코드 예제 (또한 2010 고려). CHM뿐만 아니라 HTML 문서도 만들 수 있습니다. 먼저 Sandcastle을 설치해야합니다.

+0

+1입니다 :) –

+0

을 그것은 내 Windows 7의 x64에서 작동하지 않습니다. DocProject가 항상 충돌합니다 – BrunoLM

+0

VS2010에서 가능합니까? – Saint

4

체크 아웃 doxygen

+0

+1 모래 주머니와 싸운 후 doxygen에 +1. IMO 사용하기 쉽고 멋진 결과를 얻으려면 – user430788

2

Sandcastle Help File builder은 저를 때리고 또 다른 하나

+0

이것은 최고입니다. 연말에 VS2010, VS2012, VS2013 및 아마도 VS2014를 지원합니다. MS Word, HTML, CHM 및 기타 도움말 형식으로 내보낼 수 있습니다. –