Code Documentation

[marmaxx]

There is a way to create documentation in Visual Studio 2005 (much like
javadoc) but I can't remember exactly how it's done.

Could someone refresh my memory please?

[john smith]

marmaxx wrote:

There is a way to create documentation in Visual Studio 2005 (much like
javadoc) but I can't remember exactly how it's done.

Could someone refresh my memory please?

Your XML comments are "stripped" into a XML file when you compile
("Generate XML Documentation" option must be checked). Then you use NDoc
to convert that to your preferred format (javadoc, MSDN style or
whatever else you like). That easy :)

[Chad Grooms, MCSD]

What language are you developing in? C# has XML based commenting, which can
generate a set of html reference pages, much like the MSDN library. Someone
correct me if I'm wrong, but I believe there are plugins that will allow you
to do this with VB as well.
--
-Chad Grooms, MCSD
www.chadgrooms.com
"marmaxx" wrote:

There is a way to create documentation in Visual Studio 2005 (much like
javadoc) but I can't remember exactly how it's done.

Could someone refresh my memory please?

[John Bailo]

marmaxx wrote:

There is a way to create documentation in Visual Studio 2005 (much like
javadoc) but I can't remember exactly how it's done.

Could someone refresh my memory please?

nDoc

[Kevin Spencer]

> Then you use NDoc to convert that to your preferred format (javadoc, MSDN

style or whatever else you like). That easy :)
I prefer to use XSL over NDoc, but I'm a bit of a control freak.

--
HTH,

Kevin Spencer
Microsoft MVP
..Net Developer
Who is Mighty Abbott?
A twin turret scalawag.

"john smith" <jo**@smith.com> wrote in message
news:uU*************@TK2MSFTNGP12.phx.gbl... marmaxx wrote:

There is a way to create documentation in Visual Studio 2005 (much like
javadoc) but I can't remember exactly how it's done.

Could someone refresh my memory please?

Your XML comments are "stripped" into a XML file when you compile
("Generate XML Documentation" option must be checked). Then you use NDoc
to convert that to your preferred format (javadoc, MSDN style or whatever
else you like). That easy :)