Comments in Object Browser

  • Thread starter Thread starter SR
  • Start date Start date
S

SR

I've been trying to find out how to get comments to appear in the 'Object
Browser' for my VB.Net components.

What a nightmare!!

I've created the XML Code document, so when I reference the component(s) the
comments appear in the object browser. However, the comment don't appear in
the object browser for the current solution - only when I reference it
within another solution.

And the 'Code Comment Web Report' just doesn't become useful in VB.Net.

In C++.Net it's much easier.

Why is VB.Net so different?

Is there an easier/better way of doing this?

Hopefully I'm missing a trick and someone can help. Thanks

SR.
 
OK, so I've just read that only C# supports this fully, with C++ having
limited functionality. Hopefully VB will support this soon.
 
SR,

There are some thirth party freeware tools for that, however I do not know
how far that is compatible with VB2005 where it is implemented.

Here a part of the list where you can find them in advance of the bunch of
links Herfried will provide for sure to this thread, however I saw he was
still active in this newsgroup, when it is here almost 4 o'clock (Herfried
lives in the same timezone) and now it is 8 o'clock here so probably you
will have to wait for that.

I hope this helps?

Cor

VB Commenter
http://www.gotdotnet.com/team/ide/

XML Documentation
http://www.gotdotnet.com/team/vb/


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

NDOC
http://ndoc.sourceforge.net/

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

Cor


"SR"
 
* "SR said:
I've been trying to find out how to get comments to appear in the 'Object
Browser' for my VB.Net components.

What a nightmare!!

I've created the XML Code document, so when I reference the component(s) the
comments appear in the object browser. However, the comment don't appear in
the object browser for the current solution - only when I reference it
within another solution.

And the 'Code Comment Web Report' just doesn't become useful in VB.Net.

In C++.Net it's much easier.

Why is VB.Net so different?

Is there an easier/better way of doing this?
Click to expand...

Adding tooltips in intellisense for VB.NET assemblies and creating HTML Help
documentation:

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
has to be placed in the same folder as the assembly (assembly "Foo.dll",
XML file "Foo.dll.xml").

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

<URL:http://msdn.microsoft.com/library/en-us/csref/html/vclrfprocessingxmlfile.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 keep the file up to date when 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 create an
HTML Help file from the XML formatted data.

One easy way to create the XML file is to provide information for tooltips
as XML comments inside the VB.NET 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:

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

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

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

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

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

<URL:http://www.gotdotnet.com/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/vclrfTagsForDocumentationComments.asp>
 
Thanks Herfried and Cor.

Herfried K. Wagner said:
Adding tooltips in intellisense for VB.NET assemblies and creating HTML Help
documentation:

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
has to be placed in the same folder as the assembly (assembly "Foo.dll",
XML file "Foo.dll.xml").

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

<URL:http://msdn.microsoft.com/library/en-us/csref/html/vclrfprocessingxmlfi
le.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 keep the file up to date when 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 create an
HTML Help file from the XML formatted data.

One easy way to create the XML file is to provide information for tooltips
as XML comments inside the VB.NET 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:

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

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

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

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

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

<URL:http://www.gotdotnet.com/Community/Workspaces/Workspace.aspx?id=112b544
9-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/vclrfTagsForDocument
ationComments.asp>
Click to expand...
 
Back
Top