Code Documentation

  • Thread starter Thread starter marmaxx
  • Start date Start date
M

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?
 
marmaxx said:
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?
Click to expand...

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 :)
 
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.
 
marmaxx said:
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?
Click to expand...

nDoc
 
Then you use NDoc to convert that to your preferred format (javadoc, MSDN
style or whatever else you like). That easy :)
Click to expand...

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.
 
Back
Top