Anyway to get description text for a method in my class when called from another .NET app?

  • Thread starter Thread starter Rob R. Ainscough
  • Start date Start date
R

Rob R. Ainscough

Is there a way to emulate the same "tooltip" type info that MS provide in
the VS 2003 when typing out methods.

i.e.

SqlCommand.Connection

would show tooltip "Gets or Sets the System.Data.SqlClient.SqlConnection
used by this instance of the System.Data.SqlClient.SqlCommand"

or

Response.Redirect(

would show tooltip "url: the target location"

It would be most helpful information for myself and other developers on my
team -- is there a way to make my class methods do the same tooltip?

thanks, Rob.
 
Rob,

This was discussed in http://www.developerfusion.com VB.NET forum & those
comments are done in C# if I remember correctly. Will have no idea what the
post is called, but it was over 1.5 years ago now.

Crouchie1998
BA (HONS) MCP MCSE
 
Rob R. Ainscough said:
Is there a way to emulate the same "tooltip" type info that MS provide in
the VS 2003 when typing out methods.

Yes.

This information is stored in XML files which have the same name as the DLL
they belong to with the ".xml" extension appended. Typically DLL and XML
files are placed in the same directory. Information about the structure of
these XML files can be found here:

C# Programmer's Reference -- Processing the XML File
<URL:http://msdn.microsoft.com/library/en-us/csref/html/vclrfprocessingxmlfile.asp>

Related:

Adding IntelliSense tooltips, XML comments, and documentation
<URL:http://dotnet.mvps.org/dotnet/faqs/?id=tooltipsxmldocumentation&lang=en>
 
Thank you,

I think I'll wait for VS 2005 since it will support VB -- you lucky C#
folks.
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Back
Top