Description Meta Attribute and Intellisense

Collapse
This topic is closed.
X
X
 
  • Time
  • Show
Clear All
new posts
  • Joachim Hofmann

    Description Meta Attribute and Intellisense

    Hello,

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

    <DescriptionAtt ribute("Lokales Connection-Timeout Für Feld_Ausgeben() "), _
    Category("Zeitv erhalten")_
    Public Property ConnectionTimeO ut() As Integer
    Get
    Return m_ConnectionTim eOut
    End Get
    Set(ByVal Value As Integer)
    m_ConnectionTim eOut = 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_Testp rojekt.Cdatabas e
    cd.Conn.. <- only the signature appears

    What am I missing´?

    Thank You

    Joachim
  • Peter Macej

    #2
    Re: Description Meta Attribute and Intellisense

    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>
    <DescriptionAtt ribute("Lokales Connection-Timeout Für Feld_Ausgeben() "), _
    Category("Zeitv erhalten")_
    Public Property ConnectionTimeO ut() 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.

    --
    Peter Macej
    Helixoft - http://www.helixoft.com
    VSdocman - Commenter and generator of class documentation for C#, VB
    ..NET and ASP .NET code

    Comment

    Working...