How to have comments in IntelliSense for function in Visual Studio

Question

In Visual Studio and C   when using a built in function such as ToString    IntelliSense shows a yellow box explaining what it does        How can I have that for functions and properties I write

User · Answer

Do XML commenting   like this       lt summary gt      This does something that is awesome      lt  summary gt  public void doesSomethingAwesome

User · Answer

Solmead has the correct answer   For more info you can look at XML Comments

User · Answer

lt c gt text lt  c gt  - The text you would like to indicate as code  The  lt c  tag gives you a way to indicate that text within a description should be marked as code  Use  lt code  to indicate multiple lines as code    lt code gt content lt  code gt  - The text you want marked as code  The  lt code  tag gives you a way to indicate multiple lines as code  Use  lt c  to indicate that text within a description should be marked as code    lt example gt description lt  example gt  - A description of the code sample  The  lt example  tag lets you specify an example of how to use a method or other library member  This commonly involves using the  lt code  tag    lt exception cref  member  gt description lt  exception gt  - A description of the exception  The  lt exception  tag lets you specify which exceptions can be thrown  This tag can be applied to definitions for methods  properties  events  and indexers    lt include file  filename  path  tagpath  name  id      gt   The  lt include  tag lets you refer to comments in another file that describe the types and members in your source code  This is an alternative to placing documentation comments directly in your source code file  By putting the documentation in a separate file  you can apply source control to the documentation separately from the source code  One person can have the source code file checked out and someone else can have the documentation file checked out  The  lt include  tag uses the XML XPath syntax  Refer to XPath documentation for ways to customize your  lt include  use     lt list type  bullet     number     table  gt       lt listheader gt           lt term gt term lt  term gt           lt description gt description lt  description gt       lt  listheader gt       lt item gt           lt term gt term lt  term gt           lt description gt description lt  description gt       lt  item gt   lt  list gt    The  lt listheader  block is used to define the heading row of either a table or definition list  When defining a table  you only need to supply an entry for term in the heading  Each item in the list is specified with an  lt item  block  When creating a definition list  you will need to specify both term and description  However  for a table  bulleted list  or numbered list  you only need to supply an entry for description  A list or table can have as many  lt item  blocks as needed    lt para gt content lt  para gt   The  lt para  tag is for use inside a tag  such as  lt summary    lt remarks   or  lt returns   and lets you add structure to the text    lt param name  name  gt description lt  param gt   The  lt param  tag should be used in the comment for a method declaration to describe one of the parameters for the method  To document multiple parameters  use multiple  lt param  tags  The text for the  lt param  tag will be displayed in IntelliSense  the Object Browser  and in the Code Comment Web Report    lt paramref name  name   gt   The  lt paramref  tag gives you a way to indicate that a word in the code comments  for example in a  lt summary  or  lt remarks  block refers to a parameter  The XML file can be processed to format this word in some distinct way  such as with a bold or italic font    lt permission cref  member  gt description lt  permission gt   The  lt permission  tag lets you document the access of a member  The PermissionSet class lets you specify access to a member    lt remarks gt description lt  remarks gt   The  lt remarks  tag is used to add information about a type  supplementing the information specified with  lt summary   This information is displayed in the Object Browser    lt returns gt description lt  returns gt   The  lt returns  tag should be used in the comment for a method declaration to describe the return value    lt see cref  member   gt   The  lt see  tag lets you specify a link from within text  Use  lt seealso  to indicate that text should be placed in a See Also section  Use the cref Attribute to create internal hyperlinks to documentation pages for code elements    lt seealso cref  member   gt   The  lt seealso  tag lets you specify the text that you might want to appear in a See Also section  Use  lt see  to specify a link from within text    lt summary gt description lt  summary gt   The  lt summary  tag should be used to describe a type or a type member  Use  lt remarks  to add supplemental information to a type description  Use the cref Attribute to enable documentation tools such as Sandcastle to create internal hyperlinks to documentation pages for code elements  The text for the  lt summary  tag is the only source of information about the type in IntelliSense  and is also displayed in the Object Browser    lt typeparam name  name  gt description lt  typeparam gt   The  lt typeparam  tag should be used in the comment for a generic type or method declaration to describe a type parameter  Add a tag for each type parameter of the generic type or method  The text for the  lt typeparam  tag will be displayed in IntelliSense  the Object Browser code comment web report    lt typeparamref name  name   gt   Use this tag to enable consumers of the documentation file to format the word in some distinct way  for example in italics    lt value gt property-description lt  value gt   The  lt value  tag lets you describe the value that a property represents  Note that when you add a property via code wizard in the Visual Studio  NET development environment  it will add a  lt summary  tag for the new property  You should then manually add a  lt value  tag to describe the value that the property represents

User · Answer

All these others answers make sense  but are incomplete  Visual Studio will process XML comments but you have to turn them on  Here s how to do that   Intellisense will use XML comments you enter in your source code  but you must have them enabled through Visual Studio Options  Go to Tools   Options   Text Editor  For Visual Basic  enable the Advanced   Generate XML documentation comments for     setting  For C   enable the Advanced   Generate XML documentation comments for     setting  Intellisense will use the summary comments when entered  They will be available from other projects after the referenced project is compiled   To create external documentation  you need to generate an XML file through the Project Settings   Build   XML documentation file  path that controls the compiler s  doc option  You will need an external tool that will take the XML file as input and generate the documentation in your choice of output formats   Be aware that generating the XML file can noticeably increase your compile time

User · Answer

Also the visual studio add-in ghost doc will attempt to create and fill-in the header comments from your function name

User · Answer

In CSharp  If you create the method function outline with it s Parms  then when you add the three forward slashes it will auto generate the summary and parms section   So I put in    public string myMethod string sImput1  int iInput2        I then put the three     before it and Visual Studio s gave me this        lt summary gt            lt  summary gt       lt param name  sImput1  gt  lt  param gt       lt param name  iInput2  gt  lt  param gt       lt returns gt  lt  returns gt  public string myMethod string sImput1  int iInput2

User · Answer

Those are called XML Comments  They have been a part of Visual Studio since forever   You can make your documentation process easier by using GhostDoc  a free add-in for Visual Studio which generates XML-doc comments for you  Just place your caret on the method property you want to document  and press Ctrl-Shift-D   Here s an example from one of my posts   Hope that helps

User · Answer

To generate an area where you can specify a description for the function and each parameter for the function  type the following on the line before your function and hit Enter    C        VB        See Recommended Tags for Documentation Comments  C  Programming Guide  for more info on the structured content you can include in these comments

User · Answer

What you need is xml comments - basically  they follow this syntax  as vaguely described by Solmead    C       lt summary gt     This is a description of my function      lt  summary gt  string myFunction          return  blah       VB      lt summary gt     This is a description of my function      lt  summary gt  Function myFunction   As String     Return  blah  End Function

User · Answer

Define Methods like this and you will get the help you need            lt summary gt          Adds two numbers and returns the result          lt  summary gt           lt param name  first  gt first number to add lt  param gt           lt param name  second  gt second number to  lt  param gt           lt returns gt  lt  returns gt      private int Add int first  int second                return first   second          Screenshot of the code usage

User · Answer

use     to begin each line of the comment and have the comment contain the appropriate xml for the meta data reader       lt summary gt      this method says hello     lt  summary gt  public void SayHello      Although personally  I believe that these comments are usually misguided  unless you are developing classes where the code cannot be read by its consumers

User · Answer

read http   msdn microsoft com en-us library 3260k4x7 aspx Just specifying the comments will not show the help comments in intellisense

[c#] How to have comments in IntelliSense for function in Visual Studio?

Examples related to c#

Examples related to vb.net

Examples related to visual-studio

Examples related to visual-studio-2008

Examples related to xml-comments