?
Solved

How do you get descriptions onto procedures/properties ?

Posted on 2006-10-24
6
Medium Priority
?
204 Views
Last Modified: 2010-04-23

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.
0
Comment
Question by:Kinger247
[X]
Welcome to Experts Exchange

Add your voice to the tech community where 5M+ people just like you are talking about what matters.

  • Help others & share knowledge
  • Earn cash & points
  • Learn & ask questions
  • 3
  • 3
6 Comments
 
LVL 14

Expert Comment

by:jake072
ID: 17797399
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
 
LVL 10

Author Comment

by:Kinger247
ID: 17797414
I'm using 2005, whats the native support ?
0
 
LVL 14

Accepted Solution

by:
jake072 earned 2000 total points
ID: 17797457
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
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!

 
LVL 10

Author Comment

by:Kinger247
ID: 17797480
Theres no support for that is there in vb.net ?
0
 
LVL 14

Expert Comment

by:jake072
ID: 17797711
Yes, in VS 2005 there is, not built-in for vs 2002/2003 though.

Jake
0
 
LVL 10

Author Comment

by:Kinger247
ID: 17797791
sorry, being lazy there could have double checked myself.
didn't realise it was being used now with vb.net !!!

cheers.
0

Featured Post

On Demand Webinar: Networking for the Cloud Era

Did you know SD-WANs can improve network connectivity? Check out this webinar to learn how an SD-WAN simplified, one-click tool can help you migrate and manage data in the cloud.

Question has a verified solution.

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

Article by: jpaulino
XML Literals are a great way to handle XML files and the community doesn’t use it as much as it should.  An XML Literal is like a String (http://msdn.microsoft.com/en-us/library/system.string.aspx) Literal, only instead of starting and ending with w…
Creating an analog clock UserControl seems fairly straight forward.  It is, after all, essentially just a circle with several lines in it!  Two common approaches for rendering an analog clock typically involve either manually calculating points with…
Monitoring a network: how to monitor network services and why? Michael Kulchisky, MCSE, MCSA, MCP, VTSP, VSP, CCSP outlines the philosophy behind service monitoring and why a handshake validation is critical in network monitoring. Software utilized …
In this video, Percona Director of Solution Engineering Jon Tobin discusses the function and features of Percona Server for MongoDB. How Percona can help Percona can help you determine if Percona Server for MongoDB is the right solution for …
Suggested Courses

801 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