Intellisense question

[news.microsoft.com]

How can I create a method and attach a description to it so that if someone
instantiates my object and references the object.method a description of the
method shows up.... just like the vb methods do?

I have tried things like
imports system.componentmodel

<Description("My description")> _
public sub abc()

This still doesnt work.

Thanks

 

[Carlos J. Quintero [.NET MVP]]

You need to generate a XML documentation file. Since VB.NET 2002/2003 does
not have built-in support for this (C# does), you need to use some add-in
such VBCommenter:
http://www.gotdotnet.com/team/ide/helpfiles/VBCommenter.aspx

--
Best regards,

Carlos J. Quintero

MZ-Tools: Productivity add-ins for Visual Studio .NET, VB6, VB5 and VBA
You can code, design and document much faster.
Free resources for add-in developers:
http://www.mztools.com

 

[Herfried K. Wagner [MVP]]

How can I create a method and attach a description to it so that if
someone instantiates my object and references the object.method a
description of the method shows up.... just like the vb methods do?

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

 

[Phill. W]

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

Herfried,

How does the creation of these XML documents sit with [shared]
Assemblies that have to be "registered" into the Global Assembly
Cache? Should I need to [manually] copy the xml into the GAC's
shadow copy subdirectory for them to be "absorbed" correctly by
the 'Studio IDE?

TIA,
Phill W.

 

[Herfried K. Wagner [MVP]]

How does the creation of these XML documents sit with [shared]
Assemblies that have to be "registered" into the Global Assembly
Cache? Should I need to [manually] copy the xml into the GAC's
shadow copy subdirectory for them to be "absorbed" correctly by
the 'Studio IDE?

I have never tested that. Typically assemblies are not copied to the GAC
when developing.

 

[Ross Presser]

How does the creation of these XML documents sit with [shared]
Assemblies that have to be "registered" into the Global Assembly
Cache? Should I need to [manually] copy the xml into the GAC's
shadow copy subdirectory for them to be "absorbed" correctly by
the 'Studio IDE?

I have never tested that. Typically assemblies are not copied to the GAC
when developing.

What if you are using a complex commercial library, or open source library,
in many projects? Copying it to the GAC would make sense, and you very well
might want Intellisense for it.

 

[Carlos J. Quintero [.NET MVP]]

As Herfried said, assemblies are not copìed to the GAC during DEVELOPMENT.
The GAC is a deployment feature for final apps on the machines of clients,
not a development feature. While developing, your project has references to
shared assemblies outside the GAC, in some folder. For example, the .NET
Framework dlls are in the GAC (for final apps) and also in other folder,
such as C:\WINDOWS\Microsoft.NET\Framework\v1.1.4322, and the xml files are
in that folder, not in the GAC. In fact, the Add Reference dialog of VS.NET
does not show assemblies in the GAC, it shows assemblies in folders listed
in some special registry entries such as
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VisualStudio\7.1\AssemblyFolders and
several others.


--
Best regards,

Carlos J. Quintero

MZ-Tools: Productivity add-ins for Visual Studio .NET, VB6, VB5 and VBA
You can code, design and document much faster.
Free resources for add-in developers:
http://www.mztools.com