473,714 Members | 3,296 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

Add intelisense explanation to method/property definitions

Hi,

When you view the definitions of standard methods/properties in
intelisense as well as the basic definition you get a brief
description, for example for string.length you see "Gets the number of
characters in this instance".

Is it possible to add this to my own methods & properties?

Thanks,
Mark
Nov 20 '05 #1
6 1700
Good question, I suspect it's going to invlolve an XML schema, but I dont
know how to do this. I'll be intresed at the response.

--

OHM ( Terry Burns )
. . . One-Handed-Man . . .
"Mark" <zz******@hotma il.com> wrote in message
news:9c******** *************** ***@posting.goo gle.com...
Hi,

When you view the definitions of standard methods/properties in
intelisense as well as the basic definition you get a brief
description, for example for string.length you see "Gets the number of
characters in this instance".

Is it possible to add this to my own methods & properties?

Thanks,
Mark

Nov 20 '05 #2
Hi,

Take a look at the VB Commenter power toy and Custom Helper builder.
http://www.gotdotnet.com/team/ide/
Ken
-----------------------

"Mark" <zz******@hotma il.com> wrote in message
news:9c******** *************** ***@posting.goo gle.com:
Hi,

When you view the definitions of standard methods/properties in
intelisense as well as the basic definition you get a brief
description, for example for string.length you see "Gets the number of
characters in this instance".

Is it possible to add this to my own methods & properties?

Thanks,
Mark


--
Outgoing mail is certified Virus Free.
Checked by AVG Anti-Virus (http://www.grisoft.com).
Version: 7.0.230 / Virus Database: 263.3.0 - Release Date: 6/12/2004
Nov 20 '05 #3
This power toy is neat. Unfortunately, you don't get the benefits of
intellisense unless you compile your classes into a dll. Classes local to
your project won't show the intellisense. There's a gotta be a better, pure
"attribute" solution, no?

"Ken Tucker [MVP]" <vb***@bellsout h.net> wrote in message
news:e5******** ******@TK2MSFTN GP09.phx.gbl...
Hi,

Take a look at the VB Commenter power toy and Custom Helper builder.
http://www.gotdotnet.com/team/ide/
Ken
-----------------------

"Mark" <zz******@hotma il.com> wrote in message
news:9c******** *************** ***@posting.goo gle.com:
Hi,

When you view the definitions of standard methods/properties in
intelisense as well as the basic definition you get a brief
description, for example for string.length you see "Gets the number of
characters in this instance".

Is it possible to add this to my own methods & properties?

Thanks,
Mark


--
Outgoing mail is certified Virus Free.
Checked by AVG Anti-Virus (http://www.grisoft.com).
Version: 7.0.230 / Virus Database: 263.3.0 - Release Date: 6/12/2004

Nov 20 '05 #4
According to the help, VB.Net does not directly support Code Comments used by
Intellisense.
Currently the only way to achieve this is through compilation and other means.
It has been rumored that one of the upcoming releases of VB.Net will somehow
support this.

Gerald

"Mark" <zz******@hotma il.com> wrote in message
news:9c******** *************** ***@posting.goo gle.com...
Hi,

When you view the definitions of standard methods/properties in
intelisense as well as the basic definition you get a brief
description, for example for string.length you see "Gets the number of
characters in this instance".

Is it possible to add this to my own methods & properties?

Thanks,
Mark

Nov 20 '05 #5
* zz******@hotmai l.com (Mark) scripsit:
When you view the definitions of standard methods/properties in
intelisense as well as the basic definition you get a brief
description, for example for string.length you see "Gets the number of
characters in this instance".

Is it possible to add this to my own methods & properties?


Yes.

My FAQ:

Adding tooltips in intellisense for VB.NET assemblies:

VS.NET takes the text shown in intellisense tips from an XML file that
is provided in addition to the assembly (for example, a DLL). The XML
file must have the same name as the corresponding DLL with ".xml"
appended and must be placed in the same folder as the assembly
(assembly "Foo.dll", XML file "Foo.dll.xm l").

The format of the XML file taken by VS.NET is specified here:

<URL:http://msdn.microsoft. com/library/en-us/csref/html/vclrfprocessing xmlfile.asp>

For C#, VS.NET creates this XML file automatically (compiler option
"/doc"). For VB.NET, that's currently not supported, but this will be
possible in VB 2005.

You can create the XML file by hand, but notice that this will take a
lot of time and it will be hard to update the file if parts of the
assembly change. It's much easier to use one of the tools listed below
to create the XML file. Tools like NDOC will take the XML file and can
be used to create an HTML Help file from this data.

One easy way is to provide information for tooltips as XML comments
inside the source files and then use tools like VB.DOC to create the XML
file that contains the data. Then you can copy this file into the
assembly's directory to provide information to VS.NET that enables it to
display tooltips, or you can create a help file. The help file can be
deployed with the assembly and can be used by other developers who use
the assembly as reference.

For VB.NET 2002/2003:

My XML Comments FAQ:

VB Commenter
<URL:http://www.gotdotnet.c om/team/ide/>
-> "VB Commenter"

XML Documentation
<URL:http://www.gotdotnet.c om/team/vb/>
-> "XML Documentation"

VBXC - VB.NET XML Commentor
<URL:http://vbxmldoc.tor-erik.net/>

NDOC (formerly DOC.NET)
<URL:http://ndoc.sourceforg e.net/>

VB.DOC
<URL:http://vb-doc.sourceforge .net/>

<URL:http://www.gotdotnet.c om/Community/Workspaces/Workspace.aspx? id=112b5449-f702-46e2-87fa-86bdf39a17dd>

XML comments will be introduced to VB in version 2005 ("Whidbey").

C# XML comments:

C# Programmer's Reference -- Recommended Tags for Documentation Comments
<URL:http://msdn.microsoft. com/library/en-us/csref/html/vclrfTagsForDoc umentationComme nts.asp>

--
Herfried K. Wagner [MVP]
<URL:http://dotnet.mvps.org/>
Nov 20 '05 #6
I should qualify my statements.
VB.Net does not natively support code comments within your current project.
I believe what you want to achieve is to add an attribute to a function in the
project you are editing and have that attribute automatically parsed by the IDE
and displayed elsewhere within the same project.
There are a number of options for documenting your code and having these
extracted to an XML file when you project is compiled.
Then when you reference your project into another, you can then get your code
comments.
Just not within the same project "on-the-fly".

Gerald

"Cablewizar d" <Ca*********@Ya hoo.com> wrote in message
news:OJ******** *****@TK2MSFTNG P12.phx.gbl...
According to the help, VB.Net does not directly support Code Comments used by
Intellisense.
Currently the only way to achieve this is through compilation and other means.
It has been rumored that one of the upcoming releases of VB.Net will somehow
support this.

Gerald

"Mark" <zz******@hotma il.com> wrote in message
news:9c******** *************** ***@posting.goo gle.com...
Hi,

When you view the definitions of standard methods/properties in
intelisense as well as the basic definition you get a brief
description, for example for string.length you see "Gets the number of
characters in this instance".

Is it possible to add this to my own methods & properties?

Thanks,
Mark


Nov 20 '05 #7

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

Similar topics

2
1299
by: Eric | last post by:
Hello, I'm sure there's an easy answer for this but I can't seem to figure out why VS is behaving this way. If I create a new ASP.net project, the codebehind VB file allows me to type in the name of a control and when I hit the period all the respective methods and attributes come up for that object (isn't that intelisense?). But, If I try to create a single ASPX file with VB code inline using visual studio, the code itself does not use...
10
8083
by: eLisHa | last post by:
i have an arraylist that gets it's values dynamiclly from the database, after paging, searching & more in the ASP.net file. What im trying to do, is sort the results that are sorted in the ArrayList, each time by another field. The ArrayList contains a list of a class which i built, that fits these results. I was told to use a IComparer with the sort method, after i try'ed just ArrayList1.Sort i got the following error:...
0
953
by: ditwal001 | last post by:
hi folks i am building up a c# code generater. the c# code is deposited in the sql server database. the code is indicated in a textbox for treatment. in order to receive to more comfort i would like to integrate visual studio intelisense in the textbox. has anybody an idea how to integrate the visual studio intelisense into a common system.windows.forms.textBox
3
2791
by: bauscharln | last post by:
hoi, I just wanted to add a static method to my interface, but that's not allowed! Is there a reason for this??? (Yes, I could make an abstract base class, but that's not what I want, since I don't need an implementation.) thank you in advance, bauscharln
6
13943
by: JohnR | last post by:
I have a table with 1 row which is used to hold some application wide items (one item per field, hence I only need 1 row). I want to bind one of the fields to a textbox. After setting up the oledbconnection and dataAdapter and filling the DataSet (ds) I tried this: TextBox1.DataBindings.Add("text", ds.Tables.Item("MyFile"), "MyField") I then put the following code in the SAVE button click event:
3
1131
by: orianavim | last post by:
Hi, i'm try to build my own intelisense to some part of our system. Does anyone know where should i start from? or maybe can you refer me to a good reference or a open source code which can help me to start writing such control. What i'm trying to so is to enable my users to have the same features that we have in VS.NET on their own forms.
0
1003
by: Natan Vivo | last post by:
Hi. I have a Solution here that contains 3 DLLs and a WebSite. In one of the dlls I have some custom server controls (extending Control mostly). I have mapped them in web.config (system.web \ pages \ controls \ add) and they work ok with my prefixes, but Intelisense doesn't. Is there any way to make intelisense work in XHTML source for my custom server controls in VS 2005?
19
2436
by: zzw8206262001 | last post by:
Hi,I find a way to make javescript more like c++ or pyhon There is the sample code: function Father(self) //every contructor may have "self" argument { self=self?self:this; //every class may have this statement self.hello = function() {
0
807
by: =?iso-8859-2?Q?Piotr_Ko=B3odziej?= | last post by:
Hi I am writing VS add-in. I basicaly need to detect when user is pressing '(' char and intelisense is getting parameter information for a method. later I'll need to detect .net types of parameters as user is pressing ','. I was thinking maybe about an intelisense helper class and some events. Does such thing exist? Best Regards PK
0
8808
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However, people are often confused as to whether an ONU can Work As a Router. In this blog post, weíll explore What is ONU, What Is Router, ONU & Routerís main usage, and What is the difference between ONU and Router. Letís take a closer look ! Part I. Meaning of...
0
9316
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, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed. This is as boiled down as I can make it. Here is my compilation command: g++-12 -std=c++20 -Wnarrowing bit_field.cpp Here is the code in...
1
9077
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows Update option using the Control Panel or Settings app; it automatically checks for updates and installs any it finds, whether you like it or not. For most users, this new feature is actually very convenient. If you want to control the update process,...
0
9021
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each protocol has its own unique characteristics and advantages, but as a user who is planning to build a smart home system, I am a bit confused by the choice of these technologies. I'm particularly interested in Zigbee because I've heard it does some...
0
5951
by: conductexam | last post by:
I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and then checking html paragraph one by one. At the time of converting from word file to html my equations which are in the word document file was convert into image. Globals.ThisAddIn.Application.ActiveDocument.Select();...
0
4465
by: TSSRALBI | last post by:
Hello I'm a network technician in training and I need your help. I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs. The last exercise I practiced was to create a LAN-to-LAN VPN between two Pfsense firewalls, by using IPSEC protocols. I succeeded, with both firewalls in the same network. But I'm wondering if it's possible to do the same thing, with 2 Pfsense firewalls...
1
3159
by: 6302768590 | last post by:
Hai team i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated we have to send another system
2
2524
muto222
by: muto222 | last post by:
How can i add a mobile payment intergratation into php mysql website.
3
2113
bsmnconsultancy
by: bsmnconsultancy | last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating effective websites that not only look great but also perform exceptionally well. In this comprehensive...

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.