How do you get descriptions onto procedures/properties ?


I've created a class that is going to be used by others, so I'm trying to get descriptions on the procedures and properties etc.
Using the below code, I though would work but it doesn't.

How then do you get descriptions onto procedures/properties etc ???

'//-- CODE ----

Imports System.ComponentModel

<Description("Disconnects from the live server.")> Public Sub DisconnectFromLive(ByVal Obj As Object)
      '//-- ....code .....
End Sub

thanks in advance.
LVL 10
Kinger247Asked:
Who is Participating?
 
jake072Commented:
The native support is to add in comments with the terinary single quote operator '''

Example:

''' <summary>
''' Displays the message.
''' </summary>
''' <param name="strText">The STR text.</param>
''' <returns>False if failed, True if success!</returns>
''' <remarks>History: Danny C. McNaught Created or Modified this procedure on: 9/21/2006 at: 12:17 PM
''' </remarks>

Jake
0
 
jake072Commented:
Do you mean descriptions that show up in the intellisense?  If so, vb cannot do this on it's own (2003) but VBCommenter will allow you to use ''' to make comments.  2005 has native support for this.

Jake
0
 
Kinger247Author Commented:
I'm using 2005, whats the native support ?
0
Cloud Class® Course: Python 3 Fundamentals

This course will teach participants about installing and configuring Python, syntax, importing, statements, types, strings, booleans, files, lists, tuples, comprehensions, functions, and classes.

 
Kinger247Author Commented:
Theres no support for that is there in vb.net ?
0
 
jake072Commented:
Yes, in VS 2005 there is, not built-in for vs 2002/2003 though.

Jake
0
 
Kinger247Author Commented:
sorry, being lazy there could have double checked myself.
didn't realise it was being used now with vb.net !!!

cheers.
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.