함수 및 함수 매개변수에 설명을 추가하는 방법은 무엇입니까?

함수 및 함수 매개변수에 설명을 추가하는 방법은 무엇입니까?

VB.NET 함수를 쓰고 있어요 과부하가 많이 걸려요대부분의 .NET 함수들은 IntelliSense에 파라미터 설명이 있는 것을 보았습니다.예를 들어 입력할 때String.Compare(IntelliSense는 말합니다.Compares two specified System.String objects and returns...당신은 이해합니다.이 설명이 변경되면 동일한 기능의 오버로드된 다른 버전을 클릭합니다.매개 변수를 입력하기 시작하면 현재 입력 중인 매개 변수도 설명됩니다.예:strA: The first string to compare..

제 기능에 대한 설명은 어떻게 해야 합니까?

당신이 해야 할 일은 당신의 기능 앞에 줄에 있는 세 개의 아포스트로피를 키로 누르는 것입니다. .NET은 당신을 위해 나머지 코드를 추가할 것입니다.태그에 인텔리전트에 표시할 텍스트를 삽입합니다.

''' <summary>
''' Returns the name of the code.
''' </summary>
Function GetName() As String
    Return "Something"
End Function

매개 변수의 경우...

''' <summary>
''' Procedure description
''' </summary>
''' <param name="someVariable">someVariable description.</param>
''' <param name="someVariable">someVariable description.</param>
''' <remarks></remarks>

메서드/구성원 이름을 마우스 오른쪽 단추로 클릭하고 상황에 맞는 메뉴에서 '주석 삽입'을 선택합니다.

구성원/메소드의 XML 내용은 Visual Studio 일부 버전의 인텔리전트 팁 창에 표시됩니다.

    ''' <summary>
    ''' Summary for the method goes here
    ''' </summary>
    ''' <param name="value">Param comments go here</param>
    ''' <remarks></remarks>
Private Sub SomeMethod(ByVal value As Decimal)

xml 주석을 사용합니다.컴파일 후 인텔리센스에 로드되는 몇 가지 미리 정의된 태그가 있습니다.그리고 놀라운 것은, 만약 당신이 당신의 기능 위의 선에 커서를 둔다면, '를 누르고, 입력하면, 그것은 당신을 위해 많은 것들을 미리 채워줄 것입니다.여기 기사가 있습니다.

XML 주석을 사용하여 코드 문서화

Method 앞 줄에 커서를 놓고 세 개의 아포스트로피(''') 메서드 및 해당 매개 변수에 대한 XML 문서를 작성하기 위한 템플릿이 제공됩니다.

언급URL : https://stackoverflow.com/questions/5717359/how-to-add-description-to-functions-and-function-parameters