Class Library Description

클래스 참조하여 사용을 할때 클래스에 대한 설명이 다음과 같이 나온다.

 

위와 같이 필요한 설명은

클래스의 메서드 부분에 주석 처리를 하면 된다.

 

summary 주석 처리는 슬래시(/) 키를 세번 누르면 자동으로 생긴다.

 

/// <summary>
///
/// </summary>
/// <param name="e"></param>

 

■ 예제

Class1.cs

/// <summary>     /// 주어진 스트링을 주어진 길이만큼만 잘라서 돌려줌.     /// </summary>     /// <param name="strCut">잘라낼 원본 문자열</param>     /// <param name="intChar">제한할 글자 수</param>     /// <returns>제한된 문자열</returns>     public static string CutString(string strCut, int intChar)     {         if (strCut.Length > intChar - 3)         {             string strTemp = "";             strTemp = strCut.Substring(0, intChar - 3);             strTemp += "...";             return strTemp;         }         else         {             return strCut;         }     }

 

 

■ 메서드 요약설명

/// <summary>     /// 주어진 스트링을 주어진 길이만큼만 잘라서 돌려줌.     /// </summary>

 

■ 첫번째 인자값 설명

/// <param name="strCut">잘라낼 원본 문자열</param>

 

■ 두번째 인자값 설명

/// <param name="intChar">제한할 글자 수</param>

 

[ XML 주석 레퍼런스]

<summary>	데이터 형식이나 멤버에 대한 짤막한 요약을 제공한다.
<param>	메소드 인수를 표시한다.
<returns>	메소드의 반환값을 설명한다.
<example>	설명하고 있는 항목에 대한 코드 예제를 나타냄
<code>	여러줄을 코드로 표시하는데 사용
<remarks>	클래스나 다른 형식에 대한 개요를 지정할 수 있는 태그입니다
<exception>	함수내에서 발생할 수 있는 에러정보를 나타냄

출처 : http://blog.naver.com/whwlfnsl/70025332256