locked
self documenting RRS feed

  • Question

  •  

    Hi,

     

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

     

     

     

    tia,

     

    Tuesday, November 20, 2007 10:37 AM

Answers

All replies

  • 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

     

    Tuesday, November 20, 2007 11:57 AM
  • thank you very much Dave

     

    Smile

    Tuesday, November 20, 2007 12:29 PM
  • 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,

     

    Tuesday, November 20, 2007 1:55 PM
  • 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

     

    Tuesday, November 20, 2007 2:06 PM
  • thank you again Dave

     

     

    Smile

    Tuesday, November 20, 2007 4:19 PM