Description for parameters

  • Thread starter Thread starter Amin Sobati
  • Start date Start date
A

Amin Sobati

Hi,
I want to create description for parameters of subs or functions like what
VB.NET does (e.g when you are typing a function, a windows like a big
tooltip displays various overloaded versions of that function and when you
move between parameters, the description in bottom gets updated immediately)
Thanks,
Amin
 
I want to create description for parameters of subs or functions like what
VB.NET does (e.g when you are typing a function, a windows like a big
tooltip displays various overloaded versions of that function and when you
move between parameters, the description in bottom gets updated
immediately)

See Cor's reply in the recent thread "Howto Get Intellisense to display
<summary> attribute in VB".
 
Thanks Ken,
Its help says "you must enable XML comments", but I don't know how to do
that.
Amin
 
Hi Ken,
I have written this code:

Public Class Test




''' ------------------------------------------------------------------------
-----
''' <summary>
''' This is a sample description for P1
''' </summary>
''' <param name="P1"></param>
''' <remarks>
''' </remarks>
''' <history>
''' [Administrator] 9/18/2004 Created
''' </history>




''' ------------------------------------------------------------------------
-----
Public Sub MySub(ByVal P1 As Integer)

End Sub
End Class

Public Class Consumer
Public Sub Dummy()
Dim tmp As New Test
tmp.MySub(1)
End Sub
End Class

There were two checkboxes in VBCommenter options and both were checked. But
in "tmp.MySub(1)" the description doesn't appear. Is that all I have to do?
Thanks in advance.
Amin
 
Back
Top