2.0: generating documentation for ///

[R.A.M.]

Hello,
I am learning .NET 2.0. I need to learn how to create documentation
from /// comments. I downloaded sample project XMLsample from Web and
I generated XML documentation XMLsample.xml:

<?xml version="1.0"?>
<doc>
<assembly>
<name>XMLdoc</name>
</assembly>
<members>
<member name="T:SomeCla ss">
<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:SomeCla ss.myName">
<summary>
Store for the name property</summary>
</member>
<member name="M:SomeCla ss.SomeMethod(S ystem.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>
...
</members>
</doc>

I would like to have HTML file.
One way I see is to use XSL transform but I don't know XSLT yet. Can I
have XSLT (and so HTML) automatically?
Are there other solutions?

Thank you very much for your answers.
/RAM/

[Clive Dixon]

Take a look at the open source NDoc tool which can convert the .xml files to
a number of formats including HTML help files:

http://ndoc.sourceforge.net/

=============== =======
Clive Dixon
Digita Ltd. (www.digita.com)
"R.A.M." <r_********@poc zta.onet.pl> wrote in message
news:u4******** *************** *********@4ax.c om...

Hello,
I am learning .NET 2.0. I need to learn how to create documentation
from /// comments. I downloaded sample project XMLsample from Web and
I generated XML documentation XMLsample.xml:

<?xml version="1.0"?>
<doc>
<assembly>
<name>XMLdoc</name>
</assembly>
<members>
<member name="T:SomeCla ss">
<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:SomeCla ss.myName">
<summary>
Store for the name property</summary>
</member>
<member name="M:SomeCla ss.SomeMethod(S ystem.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>
...
</members>
</doc>

I would like to have HTML file.
One way I see is to use XSL transform but I don't know XSLT yet. Can I
have XSLT (and so HTML) automatically?
Are there other solutions?

Thank you very much for your answers.
/RAM/

[clintonG]

Its my underatanding NDoc does not function with ASP.NET 2.0. The developer
was hired by Microsoft and their "policy" forbids further development. As
you can see from the notes on SourceForge it appears nothing has been added
since Feb 2005 over a year ago.
<%= Clinton Gallagher
NET csgallagher AT metromilwaukee. com
URL http://www.metromilwaukee.com/clintongallagher/

"Clive Dixon" <cl************ *******@digita. noluncheonmeat. com> wrote in
message news:%2******** *******@TK2MSFT NGP02.phx.gbl.. .

Take a look at the open source NDoc tool which can convert the .xml files
to a number of formats including HTML help files:

http://ndoc.sourceforge.net/

=============== =======
Clive Dixon
Digita Ltd. (www.digita.com)
"R.A.M." <r_********@poc zta.onet.pl> wrote in message
news:u4******** *************** *********@4ax.c om...

Hello,
I am learning .NET 2.0. I need to learn how to create documentation
from /// comments. I downloaded sample project XMLsample from Web and
I generated XML documentation XMLsample.xml:

<?xml version="1.0"?>
<doc>
<assembly>
<name>XMLdoc</name>
</assembly>
<members>
<member name="T:SomeCla ss">
<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:SomeCla ss.myName">
<summary>
Store for the name property</summary>
</member>
<member name="M:SomeCla ss.SomeMethod(S ystem.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>
...
</members>
</doc>

I would like to have HTML file.
One way I see is to use XSL transform but I don't know XSLT yet. Can I
have XSLT (and so HTML) automatically?
Are there other solutions?

Thank you very much for your answers.
/RAM/