Intellisence

Collapse
This topic is closed.
X
X
 
  • Time
  • Show
Clear All
new posts
  • patrickparent@gmail.com

    #1

    Intellisence

    I have search this forum and I want to know if there is only the XML
    way to add function description to Intellisence, or there is any way to
    do it like this

    <Description("D escription etc...")Public Sub Qwerty

    Patrick

  • Peter Macej

    #2
    Re: Intellisence

    You can create IntelliSense info only with XML file. <Description>
    attribute is used for other purpose - Properties window. When you select
    any property of control or component in Properties Window, you can see
    short description. This description is not extracted from your comments
    but from Description attribute. See http://tinyurl.com/rvrpf for
    screenshots of all kinds of documentation you can provide for your code.

    --
    Peter Macej
    Helixoft - http://www.vbdocman.com
    VBdocman - Automatic generator of technical documentation for VB, VB
    ..NET and ASP .NET code

    Comment

    • iwdu15

      #3
      RE: Intellisence

      type in 3 comment characters in a row....then youl get an XML template to add
      descriptions for the method, returning value, and parameters
      --
      -iwdu15

      Comment

      • Peter Macej

        #4
        Re: Intellisence

        type in 3 comment characters in a row....then youl get an XML template to add
        descriptions for the method, returning value, and parameters
        Yes, but this is only half of the story. Info from XML comments is not
        compiled into assembly. You need to generate XML file and distribute it
        with your DLL.

        On the other hand, info from <Descriptionatt ribute is compiled into
        assembly so you don't need anything else. But as I said, it is only used
        in Properties window, not in Intellisense.

        To sum it up, you cannot have IntelliSense only with pure DLL file
        without additional XML file.

        --
        Peter Macej
        Helixoft - http://www.vbdocman.com
        VBdocman - Automatic generator of technical documentation for VB, VB
        ..NET and ASP .NET code

        Comment

        Working...