다음을 통해 공유


<param>(Visual Basic)

매개 변수 이름과 설명을 정의합니다.

<param name="name">description</param>

매개 변수

  • name
    메서드 매개 변수의 이름입니다.name은 큰따옴표(" ")로 묶습니다.

  • description
    매개 변수에 대한 설명입니다.

설명

메서드의 매개 변수 중 하나를 설명하려면 메서드 선언의 주석에서 <param> 태그를 사용해야 합니다.

텍스트는 <param> 태그가 다음 위치에 표시 됩니다.

  • IntelliSense의 매개 변수 정보입니다.자세한 내용은 IntelliSense 사용을 참조하십시오.

  • 개체 브라우저입니다.자세한 내용은 코드 구조 보기을 참조하십시오.

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

예제

다음 예제에서는 <param> 태그를 사용하여 id 매개 변수를 설명합니다.

''' <param name="id">The ID of the record to update.</param>
''' <remarks>Updates the record <paramref name="id"/>.
''' <para>Use <see cref="DoesRecordExist"/> to verify that
''' the record exists before calling this method.</para>
''' </remarks>
Public Sub UpdateRecord(ByVal id As Integer)
    ' Code goes here.
End Sub
''' <param name="id">The ID of the record to check.</param>
''' <returns><c>True</c> if <paramref name="id"/> exists,
''' <c>False</c> otherwise.</returns>
''' <remarks><seealso cref="UpdateRecord"/></remarks>
Public Function DoesRecordExist(ByVal id As Integer) As Boolean
    ' Code goes here.
End Function

참고 항목

참조

문서 주석에 대한 권장 XML 태그(Visual Basic)