473,382 Members | 1,390 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,382 software developers and data experts.

Functions and Design-Time tooltips...

Hi guys,

I'm just about to release a class library full of functions to my
development team, and was just wondering - for a bit of finesse and to help
the guys out at design-time - is there any way for me to create my own
function description tooltips that will be shown in the VS.NET code view
when they use my functions? I've not really had much exposure to metadata
before, so any pointers would be greatly appreciated.

Cheers,
Anth
Nov 20 '05 #1
2 2663
Hello,

"Anthony Williams" <to**@bigtone.net> schrieb:
I'm just about to release a class library full of functions
to my development team, and was just wondering - for
a bit of finesse and to help the guys out at design-time
- is there any way for me to create my own function
description tooltips that will be shown in the VS.NET
code view when they use my functions?


There are some tools available which can be used to generate the XML file
required for the tooltips:

My XML Comments FAQ:

VB Commenter
http://www.gotdotnet.com/team/ide/
-> section "VB Commenter"

XML Documentation
http://www.gotdotnet.com/team/vb/
-> section "XML Documentation"

VBXC - VB.NET XML Commentor
http://vbxmldoc.tor-erik.net/index.shtml

NDOC (formerly DOC.NET)
http://ndoc.sourceforge.net/

VB.DOC
http://vb-doc.sourceforge.net/

--
Herfried K. Wagner
MVP · VB Classic, VB.NET
http://www.mvps.org/dotnet
Nov 20 '05 #2
Herfried,

Thanks for the resources - the XML Documentation tool seems to do the trick!

Job done!
Cheers,
Anth
"Herfried K. Wagner [MVP]" <hi*******@m.activevb.de> wrote in message
news:%2***************@TK2MSFTNGP12.phx.gbl...
Hello,

"Anthony Williams" <to**@bigtone.net> schrieb:
I'm just about to release a class library full of functions
to my development team, and was just wondering - for
a bit of finesse and to help the guys out at design-time
- is there any way for me to create my own function
description tooltips that will be shown in the VS.NET
code view when they use my functions?


There are some tools available which can be used to generate the XML file
required for the tooltips:

My XML Comments FAQ:

VB Commenter
http://www.gotdotnet.com/team/ide/
-> section "VB Commenter"

XML Documentation
http://www.gotdotnet.com/team/vb/
-> section "XML Documentation"

VBXC - VB.NET XML Commentor
http://vbxmldoc.tor-erik.net/index.shtml

NDOC (formerly DOC.NET)
http://ndoc.sourceforge.net/

VB.DOC
http://vb-doc.sourceforge.net/

--
Herfried K. Wagner
MVP · VB Classic, VB.NET
http://www.mvps.org/dotnet

Nov 20 '05 #3

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

Similar topics

5
by: hokiegal99 | last post by:
A few questions about the following code. How would I "wrap" this in a function, and do I need to? Also, how can I make the code smart enough to realize that when a file has 2 or more bad...
25
by: Stijn Oude Brunink | last post by:
Hello, I have the following trade off to make: A base class with 2 virtual functions would be realy helpfull for the problem I'm working on. Still though the functions that my program will use...
11
by: Gregory L. Hansen | last post by:
I'm playing with a simulation where different parts of a system, like a controller or a thermometer or a thermal mass, are represented as classes, instantiated, and connected together like...
22
by: ypjofficial | last post by:
Is there any possibility of invoking the member functions of a class without creating an object (or even a pointer to ) of that class. eg. #include <iostream.h> class test { public: void...
16
by: Roman Susi | last post by:
Hi! Out of curiosity, how do I draw functions outside classes with UML? How module could be drawn in this case? More theoretical question is if I create classes on the fly, how UML can...
6
by: JohnQ | last post by:
I like, non-copyable, non-assignable and, most often, non-default-constructable also, as a starting point for class design: class SomeClass { SomeClass(); // disallow default construction...
6
by: Richard | last post by:
I am new to php and am looking for some quick "get up and go" help. What would the arguments for and against be for function declarations v simple include? e.g <?php include("myfunc.php");...
20
by: J de Boyne Pollard | last post by:
MThe library functions which are included to allow process Mlaunch, forking, and termination, imply that it is both Mpossible and desirable for a process to fork itself. This is Ma fundamental...
127
by: sanjay.vasudevan | last post by:
Why are the following declarations invalid in C? int f(); int f(); It would be great if anyone could also explain the design decision for such a language restricton. Regards, Sanjay
7
by: Immortal Nephi | last post by:
My project grows large when I put too many member functions into one class. The header file and source code file will have approximately 50,000 lines when one class contains thousand member...
1
by: CloudSolutions | last post by:
Introduction: For many beginners and individual users, requiring a credit card and email registration may pose a barrier when starting to use cloud servers. However, some cloud server providers now...
0
by: Faith0G | last post by:
I am starting a new it consulting business and it's been a while since I setup a new website. Is wordpress still the best web based software for hosting a 5 page website? The webpages will be...
0
by: ryjfgjl | last post by:
In our work, we often need to import Excel data into databases (such as MySQL, SQL Server, Oracle) for data analysis and processing. Usually, we use database tools like Navicat or the Excel import...
0
by: aa123db | last post by:
Variable and constants Use var or let for variables and const fror constants. Var foo ='bar'; Let foo ='bar';const baz ='bar'; Functions function $name$ ($parameters$) { } ...
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
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
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: nemocccc | last post by:
hello, everyone, I want to develop a software for my android phone for daily needs, any suggestions?
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...

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.