Documentation.

  • Thread starter Thread starter WStoreyII
  • Start date Start date
W

WStoreyII

Is there some sort of a preset way for compiling documetation about an
assembly or a project. The Reason that i ask this is that sometimes when i
look at examples for code i see things like this.
<summary>This is a summary</summary>
public function test()

end function

and then this is the same stuff that i will see in the documentation. if
this is the case how do i set this up or compile it?

Also when i use a function in side of the ide it will have a discription
that will pop up in a tool tip as well as a description for each argument as
go through the list. hwo do i accomplish this.

Thanks again for the help

WStorey II
 
Hi WStoreyII

Documentation is an advantage from C# that will be as well in VB.net in the
next version.

You can do it as well using one of these tools, however I do'nt know if you
are with this compatible with the next version of VB.net.

Hi x

For VB.NET 2002/2003:

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/>

<http://www.gotdotnet.com/Community/Workspaces/Workspace.aspx?id=112b5449-f7
02-46e2-87fa-86bdf39a17dd>


I hope this helps a little bit?

Cor
 
* "WStoreyII said:
Is there some sort of a preset way for compiling documetation about an
assembly or a project. The Reason that i ask this is that sometimes when i
look at examples for code i see things like this.
<summary>This is a summary</summary>
public function test()

end function

and then this is the same stuff that i will see in the documentation. if
this is the case how do i set this up or compile it?

Also when i use a function in side of the ide it will have a discription
that will pop up in a tool tip as well as a description for each argument as
go through the list. hwo do i accomplish this.
Click to expand...

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.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 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.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>
 
Herfried,

So i can use the /doc command in c# to Compile The Doc for the Assembly How
do I Then Convert that to the html doc that you see in the msdn
documentation?

WStoreyII
 
WStoreyII,

* "WStoreyII said:
So i can use the /doc command in c# to Compile The Doc for the Assembly How
do I Then Convert that to the html doc that you see in the msdn
documentation?
Click to expand...

As you say, the '/doc' switch currently doesn't exist in VB. It's a
C#-only feature. You can use NDOC to create a documentation in HTML help
format and/or in other formats like JavaDoc or the VS.NET help format.

I included the link in my previous post, but I assume you overlooked it
because there were so many links in the post:

I made good experiences with the VB.DOC tool in conjunction with NDOC.
VB.DOC comes with an easy-to-use GUI and can start NDOC automatically to
create the documentation output.
 
Back
Top