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>
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.
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.
Want to reply to this thread or ask your own question?
You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.