Class Description

Posted on 2006-05-13
Medium Priority
Last Modified: 2010-11-07
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.

Question by:tonelm54
1 Comment
LVL 52

Accepted Solution

Carl Tawn earned 2000 total points
ID: 16675309
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:


Featured Post

Independent Software Vendors: We Want Your Opinion

We value your feedback.

Take our survey and automatically be enter to win anyone of the following:
Yeti Cooler, Amazon eGift Card, and Movie eGift Card!

Question has a verified solution.

If you are experiencing a similar issue, please ask a related question

If you're writing a .NET application to connect to an Access .mdb database and use pre-existing queries that require parameters, you've come to the right place! Let's say the pre-existing query(qryCust) in Access takes a Date as a parameter and l…
Parsing a CSV file is a task that we are confronted with regularly, and although there are a vast number of means to do this, as a newbie, the field can be confusing and the tools can seem complex. A simple solution to parsing a customized CSV fi…
Please read the paragraph below before following the instructions in the video — there are important caveats in the paragraph that I did not mention in the video. If your PaperPort 12 or PaperPort 14 is failing to start, or crashing, or hanging, …
Loops Section Overview
Suggested Courses
Course of the Month16 days, 13 hours left to enroll

864 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question