Solved

How do you get descriptions onto procedures/properties ?

Posted on 2006-10-24
6
196 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
Is Your Active Directory as Secure as You Think?

More than 75% of all records are compromised because of the loss or theft of a privileged credential. Experts have been exploring Active Directory infrastructure to identify key threats and establish best practices for keeping data safe. Attend this month’s webinar to learn more.

 
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

Is Your Active Directory as Secure as You Think?

More than 75% of all records are compromised because of the loss or theft of a privileged credential. Experts have been exploring Active Directory infrastructure to identify key threats and establish best practices for keeping data safe. Attend this month’s webinar to learn more.

Question has a verified solution.

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

Article by: Kraeven
Introduction Remote Share is a simple remote sharing tool, enabling you to see, add and remove remote or local shares. The application is written in VB.NET targeting the .NET framework 2.0. The source code and the compiled programs have been in…
Introduction When many people think of the WebBrowser (http://msdn.microsoft.com/en-us/library/2te2y1x6%28v=VS.85%29.aspx) control, they immediately think of a control which allows the viewing and navigation of web pages. While this is true, it's a…
Windows 10 is mostly good. However the one thing that annoys me is how many clicks you have to do to dial a VPN connection. You have to go to settings from the start menu, (2 clicks), Network and Internet (1 click), Click VPN (another click) then fi…
In this video I am going to show you how to back up and restore Office 365 mailboxes using CodeTwo Backup for Office 365. Learn more about the tool used in this video here: http://www.codetwo.com/backup-for-office-365/ (http://www.codetwo.com/ba…

911 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

18 Experts available now in Live!

Get 1:1 Help Now