설치

Sandcastle : http://www.codeplex.com/Sandcastle/Release/ProjectReleases.aspx?ReleaseId=13873
HTML Help Workshop : http://msdn.microsoft.com/en-us/library/ms669985.aspx

설정

피드백 설정
- 아래의 파일에서 자신의 주소와 제목으로 변경
- C:Program FilesSandcastlePresentationvs2005ContentfeedBack_content.xml

<content xml:space="preserve">
  <item id="fb_alias">byul.kim@hansol.com</item>
  <item id="fb_product"></item>
  <item id="fb_deliverable"></item>
  <item id="fb_subject">Hansol%20Inticube%20OMC%20Library%20Feedback</item>
  <item id="fb_body"></item>
  -- 중략 --
</content>

한글 인코딩 설정
- 아래의 파일에서 한글 설정이 없다면 추가
- C:Program FilesSandcastleProductionToolsChmBuilder.config

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <languages>
    -- 중략 --
    <language id="1042" codepage="949" name="0x412 Korean" />
    -- 중략 --
  </languages>
</configuration>

프로젝트 속성 변경

프로젝트 속성 > 빌드 > XML 문서 파일 체크

주석 작성 예제

메소드

///--------------------------------------------------------------------------------------------------------------------------
/// <summary>
/// Start() 함수를 호출한 시각부터 흐른 시간을 반환해주는 function.
/// </summary>
/// <param name="timeUnit">반환할 시간의 단위.</param>
/// <param name="resetTimer">진행된 시간을 반환함과 동시에 타임를 리셋할 것인가를 나타낸다. 만약 타이머를 리셋하면
/// 다음번 이 함수를 호출할 때에는 이 함수를 호출한 시점부터 진행된 시간을 반환하게 된다.</param>
/// <returns>진행된 시간을 반환한다.</returns>
/// <exception cref="System.Exception">오류발생 예외를 발생합니다.</exception>
///
/// <example> 아래 예제는 흐른 시간을 구하는 예제이다.
/// <code>
/// private StopWatch sw = new StopWatch();
/// sw.Start();
/// MessageBox.Show("Elapsed Time : " + sw.GetElapsedTime(StopWatch.TIME_UNIT.MILLISECOND, true).ToString() + "milli second");
/// </code>
/// </example>
///
/// <remarks>
/// 2009.01.01 김별 최초 작성<br/>
/// 2008.09.02 김별 수정. 뭐뭐뭐를 수정했음.
/// </remarks>
///--------------------------------------------------------------------------------------------------------------------------

enum

/// <summary>
/// GetElapsedTime() 함수가 반환하는 시간의 단위를 지정할 때 쓰이는 enum.
/// </summary>
public enum TIME_UNIT
{
    /// <summary>초 단위.</summary>
    SECOND,

    /// <summary>밀리초 단위. (1/1000초)</summary>
    MILLISECOND,

    /// <summary>마이크로초 단위. (1/1000000초)</summary>
    MICROSECOND,

    /// <summary>나노초 단위. (1/1000000000초)</summary>
    NANOSECOND
}