2.0: generating documentation for ///

25 May 2006 8:09 AM

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: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.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>
    ...
    </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/

25 May 2006 12:16 PM

Jay B. Harlow [MVP - Outlook]

RAM,
One popular tool is NDoc.

http://ndoc.sourceforge.net/

I thought I saw a blog entry recently that discussed a version of NDoc for
..Net 2.0, however I am having trouble finding the entry right now...

--
Hope this helps
Jay B. Harlow [MVP - Outlook]
..NET Application Architect, Enthusiast, & Evangelist
T.S. Bradley - http://www.tsbradley.net

Show quote