Solved

How do you get descriptions onto procedures/properties ?

Posted on 2006-10-24
6
197 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
  • 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 500 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
The Eight Noble Truths of Backup and Recovery

How can IT departments tackle the challenges of a Big Data world? This white paper provides a roadmap to success and helps companies ensure that all their data is safe and secure, no matter if it resides on-premise with physical or virtual machines or in the cloud.

 
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

NAS Cloud Backup Strategies

This article explains backup scenarios when using network storage. We review the so-called “3-2-1 strategy” and summarize the methods you can use to send NAS data to the cloud

Question has a verified solution.

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

Suggested Solutions

It’s quite interesting for me as I worked with Excel using vb.net for some time. Here are some topics which I know want to share with others whom this might help. First of all if you are working with Excel then you need to Download the Following …
It was really hard time for me to get the understanding of Delegates in C#. I went through many websites and articles but I found them very clumsy. After going through those sites, I noted down the points in a easy way so here I am sharing that unde…
A short tutorial showing how to set up an email signature in Outlook on the Web (previously known as OWA). For free email signatures designs, visit https://www.mail-signatures.com/articles/signature-templates/?sts=6651 If you want to manage em…

777 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