Ross, Check out NDoc at http://ndoc.sourceforge.net -- it will do it for you, or even put it into JavaDoc format if you'd like! It's a fantastic, very easy to use program that documents your entire public interface; those that have comments and those that don't.
Enjoy! -jk -----Original Message----- From: dotnet discussion [mailto:[EMAIL PROTECTED]] On Behalf Of Ross Lambert Sent: Saturday, April 13, 2002 2:49 PM To: [EMAIL PROTECTED] Subject: Re: [DOTNET] Goofy Question: What are "///" called? Much thanks Jason, Jeff, et al. The "/doc comments" seem much akin to javadocs, only better (yes, I am Java programmer eating crow as I dig into C#). :-) I almost fell outta my chair when I saw them pop up in tooltips. That was very cool. I kept looking up "xmldoc" and variants to find docs. "Documentation Comments" will return (almost) everything you want to know in MSDN. Anybody have an XSL file to transform the ouput to HTML or PDF? Thanks again. == Ross == -----Original Message----- From: dotnet discussion [mailto:[EMAIL PROTECTED]]On Behalf Of Jason Diamond Sent: Wednesday, April 10, 2002 10:56 PM To: [EMAIL PROTECTED] Subject: Re: [DOTNET] Goofy Question: What are "///" called? I've made a habit of calling them "/doc comments" since that's the option to csc that extracts them outputs them into an XML file. Type "/doc" into your MSDN index and you can read all about them from there. Jason ----- Original Message ----- From: "Ross Lambert" <[EMAIL PROTECTED]> To: <[EMAIL PROTECTED]> Sent: Wednesday, April 10, 2002 6:07 PM Subject: [DOTNET] Goofy Question: What are "///" called? > Fellow DotNetsters... > > I've been working with Visual C# a couple days now and have noticed a > semi-automated documentation functionality in the editor. It gives me > this kind of stuff: > > /// <summary> > /// </summary> > /// <param name="srcXML"></param> > /// <param name="writer"></param> > /// <param name="xsl"></param> > > What is this feature called that I might RTFM? :-) I must be having a major > brainfart today to be struggling with something so silly. > Oy. > > Thanks. > > == Ross == > > Ross W. Lambert > WebWolves, LLC > www.webwolves.com > > You can read messages from the DOTNET archive, unsubscribe from > DOTNET, or subscribe to other DevelopMentor lists at > http://discuss.develop.com. > You can read messages from the DOTNET archive, unsubscribe from DOTNET, or subscribe to other DevelopMentor lists at http://discuss.develop.com. You can read messages from the DOTNET archive, unsubscribe from DOTNET, or subscribe to other DevelopMentor lists at http://discuss.develop.com. You can read messages from the DOTNET archive, unsubscribe from DOTNET, or subscribe to other DevelopMentor lists at http://discuss.develop.com.
