Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

DocProject vs Sandcastle Help File Builder GUI

Tags:

I have several C# projects along with some internal library components that I'm trying to document together. Sandcastle seems to be the place to go to generate documentation from C#. I would like to know which of the two, DocProject or Sandcastle Help File Builder GUI is better and supports the features I need.

I would like to compile only each projects own part of the document and then have it all integrated together in the end. (i.e. the library components in one documentation project and each project in it's own documentation project, then all of the above in a single root using the Help 2 viewer)

like image 656
Nathan Avatar asked Nov 26 '08 03:11

Nathan


People also ask

What is sandcastle help file builder?

The Sandcastle Help File Builder standalone GUI provides an environment in which you can edit the properties that control the features and appearance of the compiled help file. In addition, it lets you manage various files associated with the help project. A Visual Studio package is also available.

How do you use the Sandcastle in Visual Studio 2022?

Within Visual Studio you can place your documentation within XML tags and then use Sandcastle to make a nice CHM (help) file. To turn on the XML Documentation functionality, you need to right-click on your project and select Properties. Then on the Build tab check the XML documentation file check box.


1 Answers

I can vouch for Sandcastle Help File Builder. It works really well and you can document any number of assemblies within a Sandcastle Help File Builder project. In theory, you could have a Builder project and generate a doc for each C# project and then have a master Builder project which documents everything.

like image 166
Ben Griswold Avatar answered Sep 21 '22 15:09

Ben Griswold