본문 바로가기
IT-개발,DB

[개발] C# 프로그래머 참조 - 문서 주석에 대한 권장 태그 <example>

by SB리치퍼슨 2010. 11. 1.

C# 프로그래머 참조  

<example>

<example>description</example>

다음은 각 문자에 대한 설명입니다.

description
코드 예제에 대한 설명입니다.

설명

<example> 태그를 사용하면 메서드나 기타 라이브러리 멤버의 사용 방법에 대한 예제를 지정할 수 있습니다. 대개 이 태그는 <code> 태그와 함께 사용합니다.

/doc로 컴파일하여 문서 주석을 파일로 저장합니다.

예제

// xml_example_tag.cs
// compile with: /doc:xml_ctag.xml

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

참고 항목

문서 주석에 대한 권장 태그

반응형

댓글