473,747 Members | 2,886 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

Documentation.

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
Nov 20 '05 #1
5 1494
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.c om/team/ide/>
-> section "VB Commenter"

XML Documentation
<http://www.gotdotnet.c om/team/vb/>
-> section "XML Documentation"

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

NDOC (formerly DOC.NET)
<http://ndoc.sourceforg e.net/>

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

<http://www.gotdotnet.com/Community/W...id=112b5449-f7
02-46e2-87fa-86bdf39a17dd>
I hope this helps a little bit?

Cor
Nov 20 '05 #2
* "WStoreyII" <pa**********@s bcglobal.net> scripsit:
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.


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.xm l").

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

<URL:http://msdn.microsoft. com/library/en-us/csref/html/vclrfprocessing xmlfile.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.c om/team/ide/>
-> "VB Commenter"

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

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

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

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

<URL:http://www.gotdotnet.c om/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/vclrfTagsForDoc umentationComme nts.asp>

--
Herfried K. Wagner [MVP]
<URL:http://dotnet.mvps.org/>
Nov 20 '05 #3
* "WStoreyII" <pa**********@s bcglobal.net> scripsit:
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.


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.xm l").

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

<URL:http://msdn.microsoft. com/library/en-us/csref/html/vclrfprocessing xmlfile.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.c om/team/ide/>
-> "VB Commenter"

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

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

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

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

<URL:http://www.gotdotnet.c om/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/vclrfTagsForDoc umentationComme nts.asp>

--
Herfried K. Wagner [MVP]
<URL:http://dotnet.mvps.org/>
Nov 20 '05 #4
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

"Herfried K. Wagner [MVP]" <hi************ ***@gmx.at> wrote in message
news:u1******** ******@TK2MSFTN GP09.phx.gbl...
* "WStoreyII" <pa**********@s bcglobal.net> scripsit:
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.
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.xm l").

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

<URL:http://msdn.microsoft.com/library/en...rocessingxmlfi
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 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.c om/team/ide/>
-> "VB Commenter"

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

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

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

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

<URL:http://www.gotdotnet.com/Community/W...spx?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...agsForDocument
ationComments.a sp>
--
Herfried K. Wagner [MVP]
<URL:http://dotnet.mvps.org/>

Nov 20 '05 #5
WStoreyII,

* "WStoreyII" <pa**********@s bcglobal.net> scripsit:
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?


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:
NDOC (formerly DOC.NET)
<URL:http://ndoc.sourceforg e.net/>
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.
VB.DOC
<URL:http://vb-doc.sourceforge .net/>


--
Herfried K. Wagner [MVP]
<URL:http://dotnet.mvps.org/>
Nov 20 '05 #6

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

Similar topics

20
3277
by: Daniel R. Smorey Jr. | last post by:
I'm looking for a good place for Python documentation. I'm really lost on why it's so hard to find anything when it comes to me looking up a particular function in Python. My example would be the split() function of the string module. Why can't I just go to www.python.org and click on Search and then type in split and it bring me to the split() function of the string module? Why does it have to be so hard? This is what I get when I...
11
1983
by: Steve | last post by:
posted on: comp.lang.python emailed to: docs@python.org I have a suggestion/request that will, I think, improve the Python documentation. Currently, the Python documentation in HTML format is stored at URLs that change with each new release of Python. That is, for example, the documentation for the os module is at http://python.org/doc/2.3/lib/module-os.html for release 2.3 of Python,
24
2232
by: Christopher J. Bottaro | last post by:
This post is just the culmination of my thoughts and discussions with my coworkers on Python. If you are not interested, please skip over it. At my work, we are developing a product from scratch. It is completely modular and the modules communicate via SOAP. Because of that, we can implement individual modules in any language of our choosing (so long as they have good SOAP libs). I chose to do all mine in Python because I'm a huge...
0
2155
by: Jeff Levinson [mcsd] | last post by:
I'm an architect for a very large fortune 100 company and we still struggle with the best balance. However, I use a couple of simple guidelines that have worked very well for me in almost all cases (there have been some times when I've lived to regret some decisions). Use case work flows are the bread and butter of the documentation and all others flow from them. Each of the high-level processes needs to be broken down into lower level...
0
2417
by: Almoni | last post by:
Hi, I have a few .xsd files that include each other in the following way: <!-- lets call the main schema file AA.xsd and it includes BB.xsd inside it --> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
1
2981
by: Ole Hanson | last post by:
I would like to be able to generate documentation for a custom configuration file (xml) to enable future support engineers to understand applicable values to the various elements inside the configuration file. (see below for sample). Does any program exist (like NDoc) that is able to generate MSDN like documentation?
97
4385
by: Cameron Laird | last post by:
QOTW: "Python makes it easy to implement algorithms." - casevh "Most of the discussion of immutables here seems to be caused by newcomers wanting to copy an idiom from another language which doesn't have immutable variables. Their real problem is usually with binding, not immutability." - Mike Meyer Among the treasures available in The Wiki is the current copy of "the Sorting min-howto":
0
1819
by: innovasys | last post by:
TORQUAY, DEVON, UK - Innovasys announced the release of Document! X 5, the fifth version of the documentation solution of choice for developers using Microsoft Visual Studio or the .NET Framework. Document! X 5 automatically produces professional quality technical documentation and on-line help for Microsoft .NET Framework assemblies (.NET Framework 1.0, 1.1 and 2.0 are all supported), COM components and controls, Visual Basic source code,...
34
2928
by: nicolasfr | last post by:
Hi, I am a bit disapointed with the current Python online documentation. I have read many messages of people complaining about the documentation, it's lack of examples and the use of complicated sentences that you need to read 10 times before understanding what it means. That's why I have started a collaborative project to make a user contributed Python documentation. The wiki is online here: http://www.pythondocs.info
0
8979
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However, people are often confused as to whether an ONU can Work As a Router. In this blog post, we’ll explore What is ONU, What Is Router, ONU & Router’s main usage, and What is the difference between ONU and Router. Let’s take a closer look ! Part I. Meaning of...
0
8818
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can effortlessly switch the default language on Windows 10 without reinstalling. I'll walk you through it. First, let's disable language synchronization. With a Microsoft account, language settings sync across devices. To prevent any complications,...
0
9522
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed. This is as boiled down as I can make it. Here is my compilation command: g++-12 -std=c++20 -Wnarrowing bit_field.cpp Here is the code in...
0
9223
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each protocol has its own unique characteristics and advantages, but as a user who is planning to build a smart home system, I am a bit confused by the choice of these technologies. I'm particularly interested in Zigbee because I've heard it does some...
0
8233
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing, and deployment—without human intervention. Imagine an AI that can take a project description, break it down, write the code, debug it, and then launch it, all on its own.... Now, this would greatly impact the work of software developers. The idea...
0
4860
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
1
3296
by: 6302768590 | last post by:
Hai team i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated we have to send another system
2
2771
muto222
by: muto222 | last post by:
How can i add a mobile payment intergratation into php mysql website.
3
2203
bsmnconsultancy
by: bsmnconsultancy | last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating effective websites that not only look great but also perform exceptionally well. In this comprehensive...

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.