self documenting

Question

 

Hi,

 

which menu option do I select to create the document that encapsulates all the /// comments that I have made?

 

 

 

tia,

 

Answer 1

Hi,

 

See the following MSDN article:

 

How to: Generate XML Documentation for a Project

http://msdn2.microsoft.com/en-us/library/x4sa0ak0(VS.80).aspx.

 

- Dave

 

Answer 2

thank you very much Dave

 

Answer 3

now that has created a nicely fornatted XML script

 

does Visual Studio convert it into a document or do I have to use a third party tool?

 

 

 

 

many thanks,

 

Answer 4

Hi,

 

Visual Studio 2005 does not provide a means to compile HTML help from XML documentation, although it does ship with a third-party product that can build Help 2.x for integration into Visual Studio's help collections.

 

You should try Sandcastle if you want to build compiled help 1.x (.chm file) or web-ready HTML help that looks like MSDN online, for example.

 

I've written an open source VS add-in that integrates Sandcastle into Visual Studio.  It's called DocProject and it's available on CodePlex.

 

See the following article for more information about Sandcastle:

 

Sandcastle Help

http://www.codeplex.com/DocProject/Wiki/View.aspx?title=Sandcastle+Help

 

- Dave

 

Answer 5

thank you again Dave