반응형 주석19 [개발] C# 프로그래머 참조 - 문서 주석에 대한 권장 태그 C# 프로그래머 참조 문서 주석에 대한 권장 태그 http://msdn.microsoft.com/library/kor/default.asp?url=/library/kor/csref/html/vclrftagsfordocumentationcomments.asp C# 컴파일러는 코드의 문서 주석을 XML 파일로 만듭니다. XML 파일을 처리하여 문서를 만드는 작업은 사용자의 사이트에서 구현해야 하는 세부적인 사항입니다. 태그는 형식, 형식 멤버 등과 같은 코드 구문에서 처리됩니다. 참고 태그는 네임스페이스에서 처리되지 않습니다. 컴파일러는 유효한 XML 태그를 모두 처리합니다. 아래 태그에는 사용자 문서에서 자주 사용하는 기능이 포함되어 있습니다. 1 1 1 1 1 1 1 1. 컴파일러는 구문을 검증합니다. .. 2010. 11. 1. [개발] C# 프로그래머 참조 - 문서 주석에 대한 권장 태그 <c> C# 프로그래머 참조 text 다음은 각 문자에 대한 설명입니다. text 코드로 나타낼 텍스트입니다. 설명 태그는 설명에 있는 텍스트를 코드로 표시하는 데 사용합니다. 여러 줄을 코드로 표시하려면 를 사용합니다. /doc로 컴파일하여 문서 주석을 파일로 저장합니다. 예제// xml_c_tag.cs // compile with: /doc:xml_c_tag.xml /// text for class MyClass public class MyClass { /// MyMethod is a method in the MyClass class. /// public static void MyMethod(int Int1) { } /// text for Main public static void Main () { } } .. 2010. 11. 1. [개발] C# 프로그래머 참조 - 문서 주석에 대한 권장 태그 <code> C# 프로그래머 참조 content 다음은 각 문자에 대한 설명입니다. content 코드로 표시할 텍스트입니다. 설명 태그는 여러 줄을 코드로 표시하는 데 사용합니다. 태그는 설명에 있는 텍스트를 코드로 표시하는 데 사용합니다. /doc로 컴파일하여 문서 주석을 파일로 저장합니다. 예제 태그의 사용 방법을 보여 주는 예제는 항목을 참조하십시오. 참고 항목 문서 주석에 대한 권장 태그 2010. 11. 1. [개발] C# 프로그래머 참조 - 문서 주석에 대한 권장 태그 <example> C# 프로그래머 참조 description 다음은 각 문자에 대한 설명입니다. description 코드 예제에 대한 설명입니다. 설명 태그를 사용하면 메서드나 기타 라이브러리 멤버의 사용 방법에 대한 예제를 지정할 수 있습니다. 대개 이 태그는 태그와 함께 사용합니다. /doc로 컴파일하여 문서 주석을 파일로 저장합니다. 예제// xml_example_tag.cs // compile with: /doc:xml_ctag.xml /// text for class MyClass public class MyClass { /// /// The GetZero method. /// /// This sample shows how to call the GetZero method. /// /// class MyClass.. 2010. 11. 1. [개발] C# 프로그래머 참조 - 문서 주석에 대한 권장 태그 <exception> C# 프로그래머 참조 description 다음은 각 문자에 대한 설명입니다. cref = "member" 현재 컴파일 환경에 있는 예외에 대한 참조. 컴파일러에서는 지정된 예외가 존재하는지를 확인하고 member를 출력 XML의 정식 요소 이름으로 변환합니다. member는 큰따옴표(" ")로 묶어야 합니다. description 설명. 설명 throw할 수 있는 예외를 태그에 지정합니다. 이 태그는 메서드 정의에 적용됩니다. /doc로 컴파일하여 문서 주석을 파일로 저장합니다. 예제// xml_exception_tag.cs // compile with: /doc:xml_exception_tag.xml using System; /// comment for class public class EClass .. 2010. 10. 29. [개발] C# 프로그래머 참조 - 문서 주석에 대한 권장 태그 <include> C# 프로그래머 참조 다음은 각 문자에 대한 설명입니다. filename 문서를 포함할 파일 이름입니다. 파일 이름은 path로 한정될 수 있습니다. filename은 작은따옴표(' ')로 묶습니다. tagpath 태그의 name을 찾을 수 있는 filename의 태그 경로입니다. path는 작은따옴표(' ')로 묶습니다. name 주석 앞에 오는 태그의 이름 지정자입니다. name에는 id가 있어야 합니다. id 주석 앞에 오는 태그의 ID입니다. ID는 큰따옴표(" ")로 묶습니다. 설명 태그를 사용하면 소스 코드의 형식과 멤버를 설명하는 다른 파일의 주석을 참조할 수 있습니다. 이렇게 하면 소스 코드 파일에 직접 문서 주석을 배치하지 않아도 됩니다. 태그는 XML XPath 구문을 사용합니다. 의 .. 2010. 10. 29. 이전 1 2 3 4 다음 반응형