Class Description

When I use a functon or sub in VB.net that has been proffesionaly compiled in a class I get a desctiption while using intelisence.

How do you do this????

I know how to code and compile classes, but would really like to be able to put descriptions on my methods and functions.

Tony
tonelm54Asked:
Who is Participating?
 
Carl TawnConnect With a Mentor Systems and Integration DeveloperCommented:
I think what you are referring to is XML documentation. This is available in C# and VB.Net (as of version 2), and can be used to document classes, methods, etc.

Commenting in VB looks something like:

   ''' <summary>
   ''' Class representing a human being
   ''' </summary>
   ''' <remarks></remarks>
   Public Class Person
       ''' <summary>
       ''' Does something to a person
       ''' </summary>
       ''' <remarks></remarks>
       Public Sub DoSomething()
   
       End Sub
   End Class


The summary will be show by IntelliSense and, aditionally, XML commenting can be used to create CHM documents that fully document you objects.

A better explanation of the available documenting tags can be found here:

    http://msdn2.microsoft.com/en-us/library/ms172653.aspx
0
Question has a verified solution.

Are you are experiencing a similar issue? Get a personalized answer when you ask a related question.

Have a better answer? Share it in a comment.

All Courses

From novice to tech pro — start learning today.