[비주얼스튜디오 .CHM ] 간편주석 , 도움말을 만들자

간단히 알고 넘어가는 주석문

문서 주석에 대한 권장 태그(C# 프로그래밍 가이드)

C# 컴파일러는 코드의 문서 주석을 XML 파일로 만듭니다. XML 파일을 처리하여 문서를 만드는 작업은 사용자의 사이트에서 구현해야 하는 세부적인 사항입니다.

태그는 형식, 형식 멤버 등과 같은 코드 구문에서 처리됩니다.

컴파일러는 유효한 XML 태그를 모두 처리합니다. 아래 태그에는 사용자 문서에서 자주 사용하는 기능이 포함되어 있습니다.

예제)

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <summary>
    /// The GetZero method.
    /// </summary>
    /// <example> This sample shows how to call the GetZero method.
    /// <code>
    /// class TestClass 
    /// {
    ///     static int Main() 
    ///     {
    ///         return GetZero();
    ///     }
    /// }
    /// </code>
    /// </example>
    public static int GetZero()
    {
        return 0;
    }

    /// text for Main
    static void Main()
    {
    }
}

주석관련 참조 내용

http://msdn.microsoft.com/ko-kr/library/5ast78ax(VS.80).aspx

GhostDoc 으로 문서작성

http://www.roland-weigelt.de/ghostdoc/

 

Document This 는 있어도 되고 없어도 됨

걍 /// 세개 때리면 주석 라인 만들어 줘요 ㅎㅎㅎ

프로젝트 속성에서는 XML 문서파일이 만들어 지도록 합니다.

http://www.codeplex.com/Sandcastle

Sandcastle 으로 XML 문서를 컴파일 하면 도움말 형식으로 문서가 만들어 집니다

실행프로그램 위치는

C:\Program Files\Sandcastle\Examples\generic

 

아우풋은 에 이름을 적으면 그 프로젝트 명으로

C:\Program Files\Sandcastle\Examples\ 하단에 폴더가 생성됩니다

완료되었을땐 DLL 과 XML 문서도 같이 복사됩니다

vs2005 형식으로 만들었다면 vs2005\chm 하단에 도움말 파일이 만들어 질겁니다

 

공식(?!) 다운로드 경로

HTML Help Workshop and Documentation
http://www.microsoft.com/downloads/details.aspx?familyid=00535334-C8A6-452F-9AA0-D597D16580CC&displaylang=en

이거랑 아래꺼 같이 깔아주세요

Sandcastle - Version 2.4.10520
http://www.microsoft.com/downloads/details.aspx?familyid=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en