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. C#
  4. Is there any way to diaplay description of a function as tooltip for a userdefined function C#

Is there any way to diaplay description of a function as tooltip for a userdefined function C#

Scheduled Pinned Locked Moved C#
csharphelptutorial
5 Posts 3 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.
  • N Offline
    N Offline
    nicolus
    wrote on last edited by
    #1

    I have a Class Library in which i have lot many functions to implement my service but the problem is maximum of functions are Having similar names and similar parameters etc. when i want to use any of these functions i am some what confused which one is the one which exactly i shoould use. So is there any way to "Provide the Description of the function" along with the Prototype of the function which comes as default due to intellisence of MicroSoft. I tried the [Description("xgdfgdfg")] attribute above the function defination but no use. Can any body know how to get the user defined description for a function Thanks in Advance.

    G S 2 Replies Last reply
    0
    • N nicolus

      I have a Class Library in which i have lot many functions to implement my service but the problem is maximum of functions are Having similar names and similar parameters etc. when i want to use any of these functions i am some what confused which one is the one which exactly i shoould use. So is there any way to "Provide the Description of the function" along with the Prototype of the function which comes as default due to intellisence of MicroSoft. I tried the [Description("xgdfgdfg")] attribute above the function defination but no use. Can any body know how to get the user defined description for a function Thanks in Advance.

      G Offline
      G Offline
      girm
      wrote on last edited by
      #2

      Hi, just type /// before your function name , VS will then build some 'comments tags' you just have to fill. such as /// /// my summary for intellisens /// /// my param descr. for intellisens Hope it helps

      G N 2 Replies Last reply
      0
      • G girm

        Hi, just type /// before your function name , VS will then build some 'comments tags' you just have to fill. such as /// /// my summary for intellisens /// /// my param descr. for intellisens Hope it helps

        N Offline
        N Offline
        nicolus
        wrote on last edited by
        #3

        Wow......... It really helped... Thanks grim.

        1 Reply Last reply
        0
        • G girm

          Hi, just type /// before your function name , VS will then build some 'comments tags' you just have to fill. such as /// /// my summary for intellisens /// /// my param descr. for intellisens Hope it helps

          G Offline
          G Offline
          girm
          wrote on last edited by
          #4

          oops < > where missing /// <summary> /// my summary for intellisens /// </summary> /// <param name="sender">my param descr. for intellisens</param>

          1 Reply Last reply
          0
          • N nicolus

            I have a Class Library in which i have lot many functions to implement my service but the problem is maximum of functions are Having similar names and similar parameters etc. when i want to use any of these functions i am some what confused which one is the one which exactly i shoould use. So is there any way to "Provide the Description of the function" along with the Prototype of the function which comes as default due to intellisence of MicroSoft. I tried the [Description("xgdfgdfg")] attribute above the function defination but no use. Can any body know how to get the user defined description for a function Thanks in Advance.

            S Offline
            S Offline
            Scott Dorman
            wrote on last edited by
            #5

            What you are looking for is known as XML comments. They provide a lot of documentation possibilities for you code. You can look on MSDN or Google for "Xml comments" and find a lot of information about them. The Description attribute is a runtime concept and doesn't have any affect on the Visual Studio IDE.

            Scott.


            —In just two days, tomorrow will be yesterday. [Forum Guidelines] [Articles] [Blog]

            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