답변:
함수에 대한 설명과 함수에 대한 각 매개 변수를 지정할 수있는 영역을 생성하려면 함수 앞에 줄에 다음을 입력하고 누르십시오 Enter.
씨#: ///
VB : '''
참조 문서 주석에 대한 권장 태그 (C #을 가이드 프로그래밍) 는 이러한 의견에 포함시킬 수있는 구조화 된 내용에 대한 추가 정보를.
xml 주석 이 필요합니다. 기본적으로 Solmead가 모호하게 설명하는 것처럼이 구문을 따릅니다.
씨#
///<summary>
///This is a description of my function.
///</summary>
string myFunction() {
return "blah";
}
VB
'''<summary>
'''This is a description of my function.
'''</summary>
Function myFunction() As String
Return "blah"
End Function
<c>text</c>-코드로 표시하려는 텍스트입니다.
< c > 태그는 설명 내의 텍스트가 코드로 표시되어야 함을 나타내는 방법을 제공합니다. 여러 줄을 코드로 표시 하려면 < code >를 사용하십시오 .
<code>content</code>-코드로 표시하려는 텍스트입니다.
< code > 태그는 여러 줄을 코드로 표시하는 방법을 제공합니다. < c >를 사용 하여 설명 내의 텍스트가 코드로 표시되어야 함을 나타냅니다.
<example>description</example>-코드 샘플에 대한 설명입니다.
< example > 태그를 사용하면 메소드 또는 다른 라이브러리 멤버를 사용하는 방법의 예를 지정할 수 있습니다. 이것은 일반적으로 < code > 태그를 사용합니다 .
<exception cref="member">description</exception>-예외에 대한 설명.
< exception > 태그를 사용하면 어떤 예외를 throw 할 수 있는지 지정할 수 있습니다. 이 태그는 메소드, 특성, 이벤트 및 인덱서의 정의에 적용 할 수 있습니다.
<include file='filename' path='tagpath[@name="id"]' />
< include > 태그를 사용하면 소스 코드의 유형과 멤버를 설명하는 다른 파일의 주석을 참조 할 수 있습니다. 소스 코드 파일에 문서 주석을 직접 배치하는 대신 사용할 수 있습니다. 문서를 별도의 파일에 넣으면 소스 코드와 별도로 문서에 소스 제어를 적용 할 수 있습니다. 한 사람은 소스 코드 파일을 체크 아웃하고 다른 사람은 문서 파일을 체크 아웃 할 수 있습니다. < include > 태그는 XML XPath 구문을 사용합니다. < include > 사용 을 사용자 정의하는 방법은 XPath 설명서를 참조하십시오 .
<list type="bullet" | "number" | "table">
<listheader>
<term>term</term>
<description>description</description>
</listheader>
<item>
<term>term</term>
<description>description</description>
</item>
</list>
< listheader > 블록은 테이블 또는 정의 목록의 표제 행을 정의하는 데 사용됩니다. 테이블을 정의 할 때 제목의 용어에 대한 항목 만 제공하면됩니다. 목록의 각 항목은 < item > 블록으로 지정됩니다 . 정의 목록을 작성할 때 용어와 설명을 모두 지정해야합니다. 그러나 테이블, 글 머리 기호 목록 또는 번호 매기기 목록의 경우 설명을위한 항목 만 제공하면됩니다. 목록 또는 테이블은 필요한만큼 < item > 블록을 가질 수 있습니다 .
<para>content</para>
< para > 태그는 < summary >, < remarks > 또는 < returns > 와 같은 태그 내에서 사용 되며 텍스트에 구조를 추가 할 수 있습니다.
<param name="name">description</param>
< param > 태그는 메소드의 매개 변수 중 하나를 설명하기 위해 메소드 선언에 대한 주석에서 사용해야합니다. 여러 매개 변수를 문서화하려면 여러 < param > 태그를 사용하십시오.
< param > 태그 의 텍스트 는 IntelliSense, 개체 브라우저 및 코드 주석 웹 보고서에 표시됩니다.
<paramref name="name"/>
< paramref > 태그는 코드 주석의 단어 (예 : < summary > 또는 < remarks > 블록)가 매개 변수 를 나타냄을 표시하는 방법을 제공합니다 . XML 파일은 굵은 체 또는 기울임 꼴 글꼴과 같이 고유 한 방식으로이 단어의 형식을 지정하도록 처리 될 수 있습니다.
< permission cref="member">description</permission>
의 < 권한 > 태그는 회원의 접속을 기록 할 수 있습니다. PermissionSet 클래스를 사용하면 멤버에 대한 액세스를 지정할 수 있습니다.
<remarks>description</remarks>
< remarks > 태그는 < summary >로 지정된 정보를 보완하여 유형에 대한 정보를 추가하는 데 사용됩니다 . 이 정보는 개체 브라우저에 표시됩니다.
<returns>description</returns>
주석에서 리턴 값을 설명하기 위해
< 리턴 > 태그를 사용해야합니다.
<see cref="member"/>
< see > 태그를 사용하면 텍스트 내에서 링크를 지정할 수 있습니다. < seealso >를 사용 하여 텍스트를 참조 섹션에 배치해야 함을 나타냅니다. cref 속성을 사용하여 코드 요소의 문서 페이지에 대한 내부 하이퍼 링크를 작성하십시오.
<seealso cref="member"/>
< seealso > 태그를 사용하면 See Also 섹션에 표시 할 텍스트를 지정할 수 있습니다. 텍스트 내에서 링크를 지정 하려면 < 참조 >를 사용 하십시오 .
<summary>description</summary>
< summary > 태그는 유형 또는 유형 멤버를 설명하는 데 사용해야합니다. < 설명 >을 사용 하여 유형 설명에 보충 정보를 추가하십시오. crecastle 속성을 사용하여 Sandcastle과 같은 문서 도구가 코드 요소의 문서 페이지에 대한 내부 하이퍼 링크를 작성할 수있게하십시오. < summary > 태그 의 텍스트 는 IntelliSense의 유형에 대한 유일한 정보 소스이며 개체 브라우저에도 표시됩니다.
<typeparam name="name">description</typeparam>
< typeparam > 태그는 형식 매개 변수를 설명하기 위해 일반 유형 또는 메소드 선언에 대한 주석에서 사용해야합니다. 제네릭 형식 또는 메서드의 각 형식 매개 변수에 태그를 추가하십시오. < typeparam > 태그 의 텍스트 는 개체 브라우저 코드 주석 웹 보고서 인 IntelliSense에 표시됩니다.
<typeparamref name="name"/>
이 태그를 사용하여 문서 파일 소비자가 이탤릭체와 같이 고유 한 방식으로 단어를 형식화 할 수 있습니다.
<value>property-description</value>
< value > 태그를 사용하면 속성이 나타내는 값을 설명 할 수 있습니다. Visual Studio .NET 개발 환경에서 코드 마법사를 통해 속성을 추가 하면 새 속성에 대해 < summary > 태그 가 추가 됩니다. 그런 다음 속성이 나타내는 값을 설명하기 위해 < value > 태그를 수동으로 추가해야합니다 .
다음과 같이 XML 주석 달기
/// <summary>
/// This does something that is awesome
/// </summary>
public void doesSomethingAwesome() {}///<param name="paramName">Tralala</param>
///를 사용하여 주석의 각 줄을 시작하고 주석 에 메타 데이터 판독기에 적합한 xml이 포함되도록하십시오 .
///<summary>
/// this method says hello
///</summary>
public void SayHello();개인적으로도 소비자가 코드를 읽을 수없는 클래스를 개발하지 않는 한 이러한 의견은 일반적으로 잘못 안내된다고 생각합니다.
이를 XML 주석 이라고 합니다 . 그들은 영원히 Visual Studio의 일부였습니다.
XML 문서 주석을 생성하는 Visual Studio 용 무료 애드 인 GhostDoc 을 사용하면 문서 프로세스를보다 쉽게 수행 할 수 있습니다. 캐럿을 문서화하려는 방법 / 속성에 놓고 Ctrl-Shift-D를 누르십시오.
다음 은 내 게시물 중 하나의 예입니다 .
희망이 있습니다 :)
CSharp에서 Parms로 메소드 / 함수 개요를 작성하면 슬래시 3 개를 추가하면 요약 및 Parms 섹션이 자동으로 생성됩니다.
그래서 나는 넣었습니다.
public string myMethod(string sImput1, int iInput2)
{
}그런 다음 세 가지 ///를 앞에 넣고 Visual Studio에서 나에게 이것을주었습니다.
/// <summary>
///
/// </summary>
/// <param name="sImput1"></param>
/// <param name="iInput2"></param>
/// <returns></returns>
public string myMethod(string sImput1, int iInput2)
{
}이와 같은 방법을 정의하면 필요한 도움을받을 수 있습니다.
/// <summary>
/// Adds two numbers and returns the result
/// </summary>
/// <param name="first">first number to add</param>
/// <param name="second">second number to </param>
/// <returns></returns>
private int Add(int first, int second)
{
return first + second;
}http://msdn.microsoft.com/en-us/library/3260k4x7.aspx를 읽으십시오 . 주석 만 지정하면 인텔리전스에 도움말 주석이 표시되지 않습니다.
다른 모든 답변은 의미가 있지만 불완전합니다. Visual Studio는 XML 주석을 처리하지만 주석을 설정해야합니다. 이를 수행하는 방법은 다음과 같습니다.
Intellisense는 소스 코드에 입력 한 XML 주석을 사용하지만 Visual Studio 옵션을 통해 활성화해야합니다. 로 이동 Tools> Options> Text Editor. Visual Basic의 경우 Advanced> Generate XML documentation comments for '''설정을 사용하십시오 . C #의 경우 Advanced> Generate XML documentation comments for ///설정을 활성화하십시오 . Intellisense는 입력시 요약 설명을 사용합니다. 참조 된 프로젝트가 컴파일 된 후 다른 프로젝트에서 사용할 수 있습니다.
만들려면 외부 문서를, 당신은을 통해 XML 파일을 생성 할 필요가 Project Settings> Build> XML documentation file:경로가 컨트롤 컴파일러의 /doc옵션을 선택합니다. XML 파일을 입력으로 사용하고 원하는 출력 형식으로 문서를 생성하는 외부 도구가 필요합니다.
XML 파일을 생성하면 컴파일 시간이 눈에 띄게 증가 할 수 있습니다.
Solmead가 정답입니다. 자세한 내용은 XML 주석을 참조하십시오 .