Skip to content
  • Categories
  • Recent
  • Tags
  • Popular
  • World
  • Users
  • Groups
Skins
  • Light
  • Cerulean
  • Cosmo
  • Flatly
  • Journal
  • Litera
  • Lumen
  • Lux
  • Materia
  • Minty
  • Morph
  • Pulse
  • Sandstone
  • Simplex
  • Sketchy
  • Spacelab
  • United
  • Yeti
  • Zephyr
  • Dark
  • Cyborg
  • Darkly
  • Quartz
  • Slate
  • Solar
  • Superhero
  • Vapor

  • Default (No Skin)
  • No Skin
Collapse
Code Project
  1. Home
  2. General Programming
  3. Visual Basic
  4. showing method descriptions in VS

showing method descriptions in VS

Scheduled Pinned Locked Moved Visual Basic
visual-studiocsharptutorialquestion
9 Posts 4 Posters 0 Views 1 Watching
  • Oldest to Newest
  • Newest to Oldest
  • Most Votes
Reply
  • Reply as topic
Log in to reply
This topic has been deleted. Only users with topic management privileges can see it.
  • M Offline
    M Offline
    Mesrop Simonian
    wrote on last edited by
    #1

    Does anyone know how to show method or property descriptions for a particular class in Visual Studio's code-view? I do the following but it doesn't work: Imports System.ComponentModel Public Class JobSeeker ... _ Shared Sub delete(ByVal Name As String) ... End Sub End class I want to be able to see the descriptions of my own methods when I'm calling them. Microsoft says the description will show (if you use DescriptionAttribute) when you CLICK on the property, my guess is this is only for visual components, because in code-view you don't click on properties... any ideas guys? your input will be greatly appreciated. Regards, Mesrop

    G D M 3 Replies Last reply
    0
    • M Mesrop Simonian

      Does anyone know how to show method or property descriptions for a particular class in Visual Studio's code-view? I do the following but it doesn't work: Imports System.ComponentModel Public Class JobSeeker ... _ Shared Sub delete(ByVal Name As String) ... End Sub End class I want to be able to see the descriptions of my own methods when I'm calling them. Microsoft says the description will show (if you use DescriptionAttribute) when you CLICK on the property, my guess is this is only for visual components, because in code-view you don't click on properties... any ideas guys? your input will be greatly appreciated. Regards, Mesrop

      G Offline
      G Offline
      Gunther Meusburger
      wrote on last edited by
      #2

      the DescriptionAttribute is just shown in the propertywindow( at the lower border). i think you like to see the description by intelisense...so if you know how to do this let me know

      1 Reply Last reply
      0
      • M Mesrop Simonian

        Does anyone know how to show method or property descriptions for a particular class in Visual Studio's code-view? I do the following but it doesn't work: Imports System.ComponentModel Public Class JobSeeker ... _ Shared Sub delete(ByVal Name As String) ... End Sub End class I want to be able to see the descriptions of my own methods when I'm calling them. Microsoft says the description will show (if you use DescriptionAttribute) when you CLICK on the property, my guess is this is only for visual components, because in code-view you don't click on properties... any ideas guys? your input will be greatly appreciated. Regards, Mesrop

        D Offline
        D Offline
        Dave Kreskowiak
        wrote on last edited by
        #3

        You need a 3rd party extension to Visual Studio for this to work. VB.NET can't output the XML file needed for Intellisense to show you the description. Currently, i don't know of any extension that will do this for VB. The C++ and C# compilers WILL do this though. The Description attribute only work in the properties window... RageInTheMachine9532

        M 1 Reply Last reply
        0
        • D Dave Kreskowiak

          You need a 3rd party extension to Visual Studio for this to work. VB.NET can't output the XML file needed for Intellisense to show you the description. Currently, i don't know of any extension that will do this for VB. The C++ and C# compilers WILL do this though. The Description attribute only work in the properties window... RageInTheMachine9532

          M Offline
          M Offline
          Mesrop Simonian
          wrote on last edited by
          #4

          another blow to VB, they claim C# does nothing VB doesn't, apparently that's not the case...

          I D 2 Replies Last reply
          0
          • M Mesrop Simonian

            another blow to VB, they claim C# does nothing VB doesn't, apparently that's not the case...

            I Offline
            I Offline
            Ian Darling
            wrote on last edited by
            #5

            Unless you install the XML Commenter powertoy. Then you can. -- Ian Darling "The moral of the story is that with a contrived example, you can prove anything." - Joel Spolsky

            M 1 Reply Last reply
            0
            • M Mesrop Simonian

              another blow to VB, they claim C# does nothing VB doesn't, apparently that's not the case...

              D Offline
              D Offline
              Dave Kreskowiak
              wrote on last edited by
              #6

              Actually, from a language point of view, they DO do everything. This is just an output from the compiler that isn't supported...yet! Wait 'til the 2004 version... RageInTheMachine9532

              1 Reply Last reply
              0
              • I Ian Darling

                Unless you install the XML Commenter powertoy. Then you can. -- Ian Darling "The moral of the story is that with a contrived example, you can prove anything." - Joel Spolsky

                M Offline
                M Offline
                Mesrop Simonian
                wrote on last edited by
                #7

                I'm not sure powertoys are the way to go, doesn't the 3rd party need to have the same powertoy to be able to see the descriptions? what if I want to ship user friendly marketable components, so when the developers program, they can see description tags for each method, just like they expect to. I know it's not a language issue, but yet what this means is those who program in C# can create quality components, whereas we can't... If there is 1 limitation, you can bet there will be more.

                I 1 Reply Last reply
                0
                • M Mesrop Simonian

                  I'm not sure powertoys are the way to go, doesn't the 3rd party need to have the same powertoy to be able to see the descriptions? what if I want to ship user friendly marketable components, so when the developers program, they can see description tags for each method, just like they expect to. I know it's not a language issue, but yet what this means is those who program in C# can create quality components, whereas we can't... If there is 1 limitation, you can bet there will be more.

                  I Offline
                  I Offline
                  Ian Darling
                  wrote on last edited by
                  #8

                  Mesrop Simonian wrote: doesn't the 3rd party need to have the same powertoy to be able to see the descriptions No, because all it does is generate the XML that the standard tools need. All it does is plug the gap for VB.NET Mesrop Simonian wrote: those who program in C# can create quality components, whereas we can't... Do VB Programmers traditionally write components anyway? VB (and VB.NET) is a productivity language before all else, and this usually means gluing together existing bits to solve a specific problem more than writing new components. So it's not a big issue for me at all, and with the powertoy, it isn't an issue at all. I'm comfortable with VB.NET as a productivity tool (much more so than C#), and if I really need to ramp up performance or do something really tricky, I'll break out the C++ tools and use those. -- Ian Darling "The moral of the story is that with a contrived example, you can prove anything." - Joel Spolsky

                  1 Reply Last reply
                  0
                  • M Mesrop Simonian

                    Does anyone know how to show method or property descriptions for a particular class in Visual Studio's code-view? I do the following but it doesn't work: Imports System.ComponentModel Public Class JobSeeker ... _ Shared Sub delete(ByVal Name As String) ... End Sub End class I want to be able to see the descriptions of my own methods when I'm calling them. Microsoft says the description will show (if you use DescriptionAttribute) when you CLICK on the property, my guess is this is only for visual components, because in code-view you don't click on properties... any ideas guys? your input will be greatly appreciated. Regards, Mesrop

                    M Offline
                    M Offline
                    Mesrop Simonian
                    wrote on last edited by
                    #9

                    After a lot of pondering I finally decided to turn to my highest VB authority on this matter - Francesco Balena. Here's what he said for all those who asked me to keep them posted on this matter: ---- That feature is based on descriptions held in an XML file held in the same directory as the DLL containing the actual types and methods. To see what I mean, see all the DLLs and the pairing XML files in the C:\Windows\Microsoft.NET\Framework\v1.1.4322 folder The guys that say that it can be done only with C# are partially right, because C# makes it _easier_ to generate the XML files that the Object Browser (and Intellisense) use to store descriptions of each methods. The C# compiler has an option that gathers all the comments interspersed in code (in a special format) and generates the XML file that VS.NET uses. With VB you must generate this file manually. However, there is a tool at http://www.gotdotnet.com/team/vb/ that lets you do that with VB as well. It is true (unfortunately) that C# can do things that VB can't - most notably, operator overloading, unsigned integers, and unsafe code - but this feature isn't one of those. regards, Francesco

                    1 Reply Last reply
                    0
                    Reply
                    • Reply as topic
                    Log in to reply
                    • Oldest to Newest
                    • Newest to Oldest
                    • Most Votes


                    • Login

                    • Don't have an account? Register

                    • Login or register to search.
                    • First post
                      Last post
                    0
                    • Categories
                    • Recent
                    • Tags
                    • Popular
                    • World
                    • Users
                    • Groups