473,473 Members | 1,576 Online
Bytes | Software Development & Data Engineering Community
Create Post

Home Posts Topics Members FAQ

XML Comment documentation

Where can I find some documentation on creating XML comment files. I would
like to know the format/conventions for creating them.
Nov 19 '05 #1
5 7728
If you have .Net Framework SDK Documentation, go to XML
Documentation -> comments in Sourcefiles. There you have
details about the same.

EXAMPLE:
---------------------------------------------------
Here is the resulting XML file from the class above:
<?xml version="1.0"?>
<doc>
<assembly>
<name>xmlsample</name>
</assembly>
<members>
<member name="T:SomeClass">
<summary>
Class level summary documentation goes
here.</summary>
<remarks>
Longer comments can be associated with a type
or member
through the remarks tag</remarks>
</member>
<member name="F:SomeClass.myName">
<summary>
Store for the name property</summary>
</member>
<member name="M:SomeClass.#ctor">
<summary>The class constructor.</summary>
</member>
<member name="M:SomeClass.SomeMethod
(System.String)">
<summary>
Description for SomeMethod.</summary>
<param name="s"> Parameter description for s
goes here</param>
<seealso cref="T:System.String">
You can use the cref attribute on any tag to
reference a type or member
and the compiler will check that the
reference exists. </seealso>
</member>
<member name="M:SomeClass.SomeOtherMethod">
<summary>
Some other method. </summary>
<returns>
Return results are described through the
returns tag.</returns>
<seealso cref="M:SomeClass.SomeMethod
(System.String)">
Notice the use of the cref attribute to
reference a specific method </seealso>
</member>
<member name="M:SomeClass.Main(System.String[])">
<summary>
The entry point for the application.
</summary>
<param name="args"> A list of command line
arguments</param>
</member>
<member name="P:SomeClass.Name">
<summary>
Name property </summary>
<value>
A value tag is used to describe the property
value</value>
</member>
</members>
</doc>

Nov 19 '05 #2
Hello,

"WALDO" <Mi*****************@hotmail.com> schrieb:
Where can I find some documentation on creating XML
comment files. I would like to know the format/conventions
for creating them.


There are some tools available for creating these files.

My XML Comments FAQ:

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/

HTH,
Herfried K. Wagner
--
MVP · VB Classic, VB .NET
http://www.mvps.org/dotnet
Nov 19 '05 #3
(It's me. I'm WALDO)

I know how to create them in C#. I know there is no inherent support for
them in VB.Net. I realize there are several tools out there to do this. My
boss doesn't trust anything made outside if our company, so my options are
to either switch to C#, which I don't really want to do, or create the files
myself. If the utilities can do it, why shouldn't I be able to?

I just want to know what are the format/schema of the files? Maybe a quick
tutorial.

"WALDO" <Mi*****************@hotmail.com> wrote in message
news:eS**************@TK2MSFTNGP09.phx.gbl...
Where can I find some documentation on creating XML comment files. I would
like to know the format/conventions for creating them.

Nov 19 '05 #4
Hello,

"Rob Mayo" <Ro******@WestonSolutions.com> schrieb:
I just want to know what are the format/schema of the files? Maybe a quick
tutorial.


http://msdn.microsoft.com/library/en...ingXMLFile.asp

HTH,
Herfried K. Wagner
--
MVP · VB Classic, VB .NET
http://www.mvps.org/dotnet
Nov 19 '05 #5
There is no native support in VB.Net. But don't fret the next version will
support it. For now use NDoc - http://ndoc.sourceforge.net. It's free, and
pretty stable.

KS
http://www.nAlliance.com/

"Rob Mayo" <Ro******@WestonSolutions.com> wrote in message
news:ul****************@tk2msftngp13.phx.gbl...
OK, so I have my xml document. How do I tell VB.Net to use it. Do I just
have it compile with the assembly? If I were in C#, I could just go to
Project Properties and tell it that this is my xml file. How do I achieve
the same effect in VB.Net?

"WALDO" <Mi*****************@hotmail.com> wrote in message
news:eS**************@TK2MSFTNGP09.phx.gbl...
Where can I find some documentation on creating XML comment files. I would like to know the format/conventions for creating them.


Nov 20 '05 #6

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

Similar topics

5
by: Rob | last post by:
Hello all, If I have the following code fragment: /* comment bla bla */ ....code... With a regular expression, how do I get/extract the comment inside this multi line comment block. With...
0
by: RJ | last post by:
Visual Studio .NET has a feature available under the Tools menu, of the toolbar, Build Comment Web Pages... When I use this feature to generate documentation of my VB.NET project, the Classes and...
4
by: WALDO | last post by:
Where can I find some documentation on creating XML comment files. I would like to know the format/conventions for creating them.
2
by: comic_rage | last post by:
how do you add a comment line/section to an xml schema xsd file? like this <!-- =============================================================== --> <!-- =================== My comment line ...
3
by: David Martin | last post by:
Is there a way to insert a newline into a documentation comment? The intention is to have the tooltip that appears with Intellisense show the line breaks so that the description is easier to read....
1
by: Jianwei Sun | last post by:
I remember there is a tool which automatically put some simple comments on the properties and methods. I cannot find it anywhere, can somebody help me on this.
13
by: Ray Cassick \(Home\) | last post by:
I have been using XML Comments in VB.NET during my time with VS.NET 2003 thanks to VBXC and NDoc. I just started to upgrade one of my projects into VB.NET 2005 and am seeing some odd errors...
3
by: Martin P. Hellwig | last post by:
Hi all, I've been toying with python for about two years now. Not every day, just when I encounter something in my job (sysadmin) repetitively dull. The amazing thing is that like any other...
14
by: Siv | last post by:
Hi, Just busily coding away and removed a procedure from my code and all of a sudden an error came up miles away from the location of the piece of code I removed and it relates to the XML...
3
by: Richard | last post by:
Again, new to DB2. Trying to do something I can do in Sybase ASE. In any Sybase SQL script I can use /* */ to comment out a block of code. In the DB2 9.0 SQL Reference Manual V1 it says: ...
0
by: Hystou | last post by:
There are some requirements for setting up RAID: 1. The motherboard and BIOS support RAID configuration. 2. The motherboard has 2 or more available SATA protocol SSD/HDD slots (including MSATA, M.2...
0
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...
0
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,...
0
jinu1996
by: jinu1996 | last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven...
1
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows...
0
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...
0
by: TSSRALBI | last post by:
Hello I'm a network technician in training and I need your help. I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs. The...
0
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
0
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 ...

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.