Visual Studio 기능에 대한 IntelliSense 코멘트를 받는 방법

Visual Studio 기능에 대한 IntelliSense 코멘트를 받는 방법

Visual Studio 및 C#에서는 ToString() 등의 빌트인 함수를 사용하면 IntelliSense에 노란색 상자가 표시되어 동작을 설명합니다.

내가 쓰는 기능이나 속성에 어떻게 그것을 가질 수 있을까?

함수에 대한 설명과 함수에 대한 각 파라미터를 지정할 수 있는 영역을 생성하려면 함수 앞에 있는 행에 다음을 입력하고 를 누릅니다.

• C#: ///

• VB: '''

코멘트에 포함할 수 있는 구조화된 컨텐츠에 대한 자세한 내용은 문서 코멘트에 대한 권장 태그(C# Programming Guide)를 참조하십시오.

필요한 것은 xml 코멘트입니다.기본적으로 이 코멘트는 다음 구문을 따릅니다(Solmead에 의해 막연히 설명됨).

C#

///<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 >태그를 사용하면 어떤 예외를 설정할 수 있는지 지정할 수 있습니다.이 태그는 메서드, 속성, 이벤트 및 인덱서의 정의에 적용할 수 있습니다.

<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> 블록으로 지정됩니다.정의 목록을 작성할 때 용어와 설명을 모두 지정해야 합니다.단, 테이블, 글머리 기호 목록 또는 번호 목록의 경우 설명을 위한 항목만 지정하면 됩니다.목록 또는 테이블에는 필요한 수만큼 <항목> 블록을 포함할 수 있습니다.

<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>
<permission> 태그를 사용하면 멤버의 접근을 문서화할 수 있습니다.권한Set class를 사용하여 구성원에 대한 액세스를 지정할 수 있습니다.

<remarks>description</remarks>
<remarks> 태그는 <summary>로 지정된 정보를 보완하여 유형에 대한 정보를 추가하기 위해 사용됩니다.이 정보는 오브젝트브라우저에 표시됩니다.

<returns>description</returns>
반환값을 기술하기 위한 메서드 선언에서는 코멘트 내에서 <returns> 태그를 사용해야 합니다.

<see cref="member"/>
<see> 태그를 사용하면 텍스트 내에서 링크를 지정할 수 있습니다.텍스트를 [See Also]섹션에 배치할 필요가 있음을 나타내려면 <see also>를 사용합니다.cref 속성을 사용하여 코드 요소의 문서 페이지에 대한 내부 하이퍼링크를 만듭니다.

<seealso cref="member"/>
<see also> 태그를 사용하면 [See Also]섹션에 표시할 텍스트를 지정할 수 있습니다.텍스트내의 링크를 지정하려면 ,< see > 를 사용합니다.

<summary>description</summary>
유형 또는 유형 멤버를 기술하려면 <summary> 태그를 사용해야 합니다.유형 설명에 보충 정보를 추가하려면 <remarks>를 사용합니다.코드 요소의 문서 페이지에 대한 내부 하이퍼링크를 작성하려면 cref 속성을 사용하여 Sandcastle과 같은 문서 도구를 사용할 수 있습니다.<summary> 태그의 텍스트는 IntelliSense 유형에 대한 유일한 정보원이며 오브젝트 브라우저에도 표시됩니다.

<typeparam name="name">description</typeparam>
타입 파라미터를 기술하기 위한 범용 타입 또는 메서드 선언에서는 코멘트 내에서 <typeparam> 태그를 사용해야 합니다.일반 유형 또는 메서드의 각 유형 매개 변수에 태그를 추가합니다.<typeparam> 태그의 텍스트는 오브젝트 브라우저 코드 코멘트 Web 리포트인 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() {}

//를 사용하여 코멘트의 각 행을 시작하고 코멘트에 메타 데이터 리더에 적합한 xml을 포함시킵니다.

///<summary>
/// this method says hello
///</summary>
public void SayHello();

개인적으로는 코드를 읽을 수 없는 클래스를 개발하지 않는 한, 이러한 코멘트는 일반적으로 잘못되어 있다고 생각합니다.

이것들은 XML 코멘트라고 불립니다.그들은 영원히 Visual Studio의 일원이었다.

XML-doc 의견을 생성하는 Visual Studio용 무료 추가 기능인 GhostDoc을 사용하면 문서 프로세스를 보다 쉽게 수행할 수 있습니다.캐럿을 문서화할 메서드/속성에 놓고 Ctrl-Shift-D를 누르기만 하면 됩니다.

여기 제 게시물 중 하나의 예가 있습니다.

도움이 되었으면 좋겠다:)

다음과 같은 방법을 정의하면 필요한 도움을 받을 수 있습니다.

    /// <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;
    }

코드 사용 현황 스크린샷

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)
{
}

http://msdn.microsoft.com/en-us/library/3260k4x7.aspx 를 참조해 주세요.댓글만 지정해도 도움말댓글은 인텔리센스로 표시되지 않습니다.

다른 모든 답변은 일리는 있지만 불완전합니다.Visual Studio에서 XML 주석을 처리하지만 사용자가 XML 주석을 설정해야 합니다.그 방법은 다음과 같습니다.

Intellissense는 사용자가 소스 코드에 입력한 XML 주석을 사용하지만 Visual Studio 옵션을 통해 해당 주석을 활성화해야 합니다.★★★★★★★★★★★★★★★로 이동ToolsOptionsText Editor Basic 、 [ . Visual Basic ]를 .AdvancedGenerate XML documentation comments for '''「」. 의 경우는, C# 를 유효하게 합니다.AdvancedGenerate XML documentation comments for ///는 입력시 합니다.인텔리센스는 입력 시 요약 코멘트를 사용합니다.참조된 프로젝트가 컴파일된 후 다른 프로젝트에서 사용할 수 있습니다.

외부 매뉴얼을 작성하려면 를 통해 XML 파일을 생성해야 합니다.Project SettingsBuildXML documentation file:컴파일러를 /doc 형식으로 합니다.XML 파일을 입력으로 사용하여 원하는 출력 형식으로 문서를 생성하는 외부 도구가 필요합니다.

XML 파일을 생성하면 컴파일 시간이 현저하게 길어질 수 있습니다.

또한 Visual Studio Add-in Ghost Doc는 사용자의 함수 이름에서 헤더 코멘트를 만들고 채우려고 시도합니다.

Solmead가 정답을 맞혔어.상세한 것에 대하여는, XML 코멘트를 참조해 주세요.

언급URL : https://stackoverflow.com/questions/529677/how-to-have-comments-in-intellisense-for-function-in-visual-studio