Description Meta Attribute and Intellisense

  • Thread starter Thread starter Joachim Hofmann
  • Start date Start date
J

Joachim Hofmann

Hello,

I have a class with a property ConnectionTimeOut().
I added description meta code to it as follows.

<DescriptionAttribute("Lokales Connection-Timeout Für Feld_Ausgeben()"), _
Category("Zeitverhalten")> _
Public Property ConnectionTimeOut() As Integer
Get
Return m_ConnectionTimeOut
End Get
Set(ByVal Value As Integer)
m_ConnectionTimeOut = Value
End Set
End Property
....

I expected that if I define an Object and choose a property, Intellisense would show me the
description text, but it doesnt.

Dim cd As New CDatabase_Testprojekt.Cdatabase
cd.Conn.. <- only the signature appears

What am I missing´?

Thank You

Joachim
 
The Description attribute is only used for help in Properties Window. To
get IntelliSense help, you need to use XML comments. It should look like:

''' <summary>
''' Lokales Connection-Timeout Für Feld_Ausgeben().
''' </summary>
<DescriptionAttribute("Lokales Connection-Timeout Für Feld_Ausgeben()"), _
Category("Zeitverhalten")> _
Public Property ConnectionTimeOut() As Integer

VS or our VSdocman than generates XML file in the same directory as your
DLL. VS then automatically uses it for IntelliSense. See
http://tinyurl.com/64n9t3 for more details.
 
Back
Top