인터페이스에 주석 추가

Question

.NET Framework에서 인터페이스를 구현할 때 Visual Studio에서 주석 (및 영역과 같은 다른 장점)을 생성하는 사례를 보았습니다.

좋은 예가 IDisposable입니다. 구현하면 Visual Studio에서 다음 코드 블록을 생성합니다.

#Region "IDisposable Support" 
    Private disposedValue As Boolean ' To detect redundant calls 

    ' IDisposable 
    Protected Overridable Sub Dispose(disposing As Boolean) 
     If Not Me.disposedValue Then 
      If disposing Then 
       ' TODO: dispose managed state (managed objects). 
      End If 

      ' TODO: free unmanaged resources (unmanaged objects) and override Finalize() below. 
      ' TODO: set large fields to null. 
     End If 
     Me.disposedValue = True 
    End Sub 

    ' TODO: override Finalize() only if Dispose(ByVal disposing As Boolean) above has code to free unmanaged resources. 
    'Protected Overrides Sub Finalize() 
    ' ' Do not change this code. Put cleanup code in Dispose(ByVal disposing As Boolean) above. 
    ' Dispose(False) 
    ' MyBase.Finalize() 
    'End Sub 

    ' This code added by Visual Basic to correctly implement the disposable pattern. 
    Public Sub Dispose() Implements IDisposable.Dispose 
     ' Do not change this code. Put cleanup code in Dispose(disposing As Boolean) above. 
     Dispose(True) 
     GC.SuppressFinalize(Me) 
    End Sub 
#End Region 

이 코드는 내 코드에서 할 수 있습니까? 그렇다면 어떻게? 인터페이스의 메소드에 메소드의 일반적인 목적이 무엇인지 구현 자에게 알려주는 몇 가지 설명을 추가하고 싶습니다.

Answer 1

100 % 당신이 묻고있는 것이지만 여기에 있다면 확실하지 않습니다. 당신의 방법 정의 유형 '' '

편집기 위

그 방법을 사용하는 경우 인텔리을 구동하는 데 사용되는 XML의 조각으로 그을 확장합니다.

Private Sub Import(ByVal ImportFileName As String, ByRef OutFileName As String) 

는

''' <summary> 
''' Imports data from import file into Output File 
''' </summary> 
''' <param name="ImportFileName">the fully qualified path to the import file</param> 
''' <param name="OutFileName">the fully qualified path for the output file</param> 
''' <remarks>all the widgets need to be thoroughly castigated</remarks> 
Private Sub Import(ByVal ImportFileName As String, ByRef OutFileName As String) 

가되고,이 반입 방법 제공된 힌트가 사용될 때마다 파라미터의 이름과 함께 표시된다.