473,320 Members | 2,189 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,320 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 3967
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: ryjfgjl | last post by:
ExcelToDatabase: batch import excel into database automatically...
0
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
1
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
0
by: Vimpel783 | last post by:
Hello! Guys, I found this code on the Internet, but I need to modify it a little. It works well, the problem is this: Data is sent from only one cell, in this case B5, but it is necessary that data...
0
by: jfyes | last post by:
As a hardware engineer, after seeing that CEIWEI recently released a new tool for Modbus RTU Over TCP/UDP filtering and monitoring, I actively went to its official website to take a look. It turned...
0
by: ArrayDB | last post by:
The error message I've encountered is; ERROR:root:Error generating model response: exception: access violation writing 0x0000000000005140, which seems to be indicative of an access violation...
1
by: PapaRatzi | last post by:
Hello, I am teaching myself MS Access forms design and Visual Basic. I've created a table to capture a list of Top 30 singles and forms to capture new entries. The final step is a form (unbound)...
0
by: CloudSolutions | last post by:
Introduction: For many beginners and individual users, requiring a credit card and email registration may pose a barrier when starting to use cloud servers. However, some cloud server providers now...
1
by: Shællîpôpï 09 | last post by:
If u are using a keypad phone, how do u turn on JavaScript, to access features like WhatsApp, Facebook, Instagram....

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.