Class Description

Posted on 2006-05-13
Last Modified: 2010-11-07
When I use a functon or sub in 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

    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

    Looking for New Ways to Advertise?

    Engage with tech pros in our community with native advertising, as a Vendor Expert, and more.

    Join & Write a Comment

    I think the Typed DataTable and Typed DataSet are very good options when working with data, but I don't like auto-generated code. First, I create an Abstract Class for my DataTables Common Code.  This class Inherits from DataTable. Also, it can …
    1.0 - Introduction Converting Visual Basic 6.0 (VB6) to Visual Basic 2008+ (VB.NET). If ever there was a subject full of murkiness and bad decisions, it is this one!   The first problem seems to be that people considering this task of converting…
    Hi everyone! This is Experts Exchange customer support.  This quick video will show you how to change your primary email address.  If you have any questions, then please Write a Comment below!
    Excel styles will make formatting consistent and let you apply and change formatting faster. In this tutorial, you'll learn how to use Excel's built-in styles, how to modify styles, and how to create your own. You'll also learn how to use your custo…

    729 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

    Need Help in Real-Time?

    Connect with top rated Experts

    15 Experts available now in Live!

    Get 1:1 Help Now