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
Solved

How do you get descriptions onto procedures/properties ?

Posted on 2006-10-24
6
198 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
Free Tool: IP Lookup

Get more info about an IP address or domain name, such as organization, abuse contacts and geolocation.

One of a set of tools we are providing to everyone as a way of saying thank you for being a part of the community.

 
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

Free Tool: Site Down Detector

Helpful to verify reports of your own downtime, or to double check a downed website you are trying to access.

One of a set of tools we are providing to everyone as a way of saying thank you for being a part of the community.

Question has a verified solution.

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

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 …
A while ago, I was working on a Windows Forms application and I needed a special label control with reflection (glass) effect to show some titles in a stylish way. I've always enjoyed working with graphics, but it's never too clever to re-invent …
With Secure Portal Encryption, the recipient is sent a link to their email address directing them to the email laundry delivery page. From there, the recipient will be required to enter a user name and password to enter the page. Once the recipient …
The Email Laundry PDF encryption service allows companies to send confidential encrypted  emails to anybody. The PDF document can also contain attachments that are embedded in the encrypted PDF. The password is randomly generated by The Email Laundr…

838 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