473,386 Members | 1,864 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,386 software developers and data experts.

Is it possible to add a description to methods of a class?

I'd like to have a description included in the tool tip
(intellisense?) when I call a method from a class I wrote. Just to
make sure I'm describing this correctly, I'm talking about the yellow
box that comes up with I call the method in code that shows what
parameters that method required. Is this possible? If so, how would
I do that?

I know I can add <description("string here")> on a method of a custom
control, but how do I do it if it's not a control, just a class? I
can't seem to do it the same way.

Thanks for your help!
Nov 18 '05 #1
3 1588
If you're using C# you can add some XML Comments like so

/// <summary>
/// This is a description of my method or property
/// </summary>

right above the definition of the method or property. This will show the
text right below the parameter information. Here is an example of a
property that sets a variable called _Text.

/// <summary>
/// This is a description of my method or property
/// </summary>
public string Text
{
set{_Text = value;}
}

Hope this helps,
Mark Fitzpatrick
Microsoft MVP- FrontPage
"Big Dave" <da********@raymondjames.com> wrote in message
news:bc**************************@posting.google.c om...
I'd like to have a description included in the tool tip
(intellisense?) when I call a method from a class I wrote. Just to
make sure I'm describing this correctly, I'm talking about the yellow
box that comes up with I call the method in code that shows what
parameters that method required. Is this possible? If so, how would
I do that?

I know I can add <description("string here")> on a method of a custom
control, but how do I do it if it's not a control, just a class? I
can't seem to do it the same way.

Thanks for your help!

Nov 18 '05 #2
Unfortunately I'm using vb.net. I tried adding '<summary>Description
text</summary> right about my method, but that didn't work. Does
anybody know if there's a way to do this with vb.net?
*** Sent via Developersdex http://www.developersdex.com ***
Don't just participate in USENET...get rewarded for it!
Nov 18 '05 #3
VBCommentor will provide the ability to add coments to methods just like C#.

However, you can only see the comments if the consumer of the component is
in C#. :/

Basically, VB.Net doesn't see the comments, but if you take that same
component and use it in C#, you will see the information.
"Dave" wrote:
Unfortunately I'm using vb.net. I tried adding '<summary>Description
text</summary> right about my method, but that didn't work. Does
anybody know if there's a way to do this with vb.net?
*** Sent via Developersdex http://www.developersdex.com ***
Don't just participate in USENET...get rewarded for it!

Nov 18 '05 #4

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

0
by: Horia Tudosie | last post by:
Using Visual Studio 2003 This is to report a series of bugs regarding the FlagsAttribute and (independently) the usage of interfaces in Web applications. Let’s declare xColors type like: ...
6
by: Sergey Poberezovskiy | last post by:
Hi, I have already asked the question, but probably did not make myself clear. Back in VB6 days when you created a public method/property/event you could define what's called "Procedure...
1
by: Greg Galloway | last post by:
OK this is kind of an obscure question and I'm not sure how to phrase it but here goes: You know when you are working with an object in the .NET IDE and you are scrolling through the list of...
0
by: Edmund Green | last post by:
Included below is a minimal web-service implementation to recreate a problem I've encountered in a web service that has methods returning classes with the same local name (but in different...
5
by: Cyril Gupta | last post by:
Hello, I have a class inside another class. The Scenario is like Car->Engine, where Car is a class with a set of properties and methods and Engine is another class inside it with its own set of...
2
by: Chakravarthy | last post by:
Given an XML stream as below, is there any possibility to convert the same into any treditional class style with . (dots) as seperator of the nodes of the xml file... for instance ...
1
by: Joe Peterson | last post by:
I've been doing a lot of searching on the topic of one of Python's more disturbing issues (at least to me): the fact that if a __del__ finalizer is defined and a cyclic (circular) reference is...
7
by: Zytan | last post by:
I know you cannot have a sealed static class, but why not? Why must static classes be left open to inheritance? This article: http://msdn.microsoft.com/msdnmag/issues/03/07/NET/ recommends to...
1
by: gregory.lielens | last post by:
Hello, We are currently writing python bindings to an existing C++ library, and we encountered a problem that some of you may have solved (or that has found unsolvable :( ): A C++ class...
0
by: taylorcarr | last post by:
A Canon printer is a smart device known for being advanced, efficient, and reliable. It is designed for home, office, and hybrid workspace use and can also be used for a variety of purposes. However,...
0
by: ryjfgjl | last post by:
If we have dozens or hundreds of excel to import into the database, if we use the excel import function provided by database editors such as navicat, it will be extremely tedious and time-consuming...
0
by: ryjfgjl | last post by:
In our work, we often receive Excel tables with data in the same format. If we want to analyze these data, it can be difficult to analyze them because the data is spread across multiple Excel files...
0
BarryA
by: BarryA | last post by:
What are the essential steps and strategies outlined in the Data Structures and Algorithms (DSA) roadmap for aspiring data scientists? How can individuals effectively utilize this roadmap to progress...
1
by: Sonnysonu | last post by:
This is the data of csv file 1 2 3 1 2 3 1 2 3 1 2 3 2 3 2 3 3 the lengths should be different i have to store the data by column-wise with in the specific length. suppose the i have to...
0
by: Hystou | last post by:
There are some requirements for setting up RAID: 1. The motherboard and BIOS support RAID configuration. 2. The motherboard has 2 or more available SATA protocol SSD/HDD slots (including MSATA, M.2...
0
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can...
0
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers,...
0
jinu1996
by: jinu1996 | last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.