473,397 Members | 1,950 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,397 software developers and data experts.

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 11 '05 #1
4 3971
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 11 '05 #2
(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 11 '05 #3
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 11 '05 #4
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 11 '05 #5

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: Charles Arthur | last post by:
How do i turn on java script on a villaon, callus and itel keypad mobile phone
0
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
1
by: Sonnysonu | last post by:
This is the data of csv file 1 2 3 1 2 3 1 2 3 1 2 3 2 3 2 3 3 the lengths should be different i have to store the data by column-wise with in the specific length. suppose the i have to...
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
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,...
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
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...
0
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,...
0
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome a new...

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.