DocProject vs Sandcastle Help File Builder GUI

Question

Tengo varios proyectos C# junto con algunos componentes internos de la biblioteca que estoy tratando de documentar juntos. Sandcastle parece ser el lugar a donde ir para generar documentación desde C#. Me gustaría saber cuál de las dos, DocProject o Sandcastle Help File Builder GUI es mejor y admite las características que necesito.

Me gustaría compilar solo cada parte propia del documento y luego tenerlo todo integrado al final. (es decir, los componentes de la biblioteca en un proyecto de documentación y cada proyecto en su propio proyecto de documentación, luego todo lo anterior en una sola raíz utilizando el visor de Ayuda 2)

Answer 1

Respondo por Sandcastle Help File Builder. Funciona muy bien y puede documentar cualquier cantidad de conjuntos dentro de un proyecto de Sandcastle Help File Builder. En teoría, podría tener un proyecto de generador y generar un documento para cada proyecto C# y luego tener un proyecto maestro de construcción que documente todo.

Answer 2

Éstos son algunos enlaces útiles para castillo de arena documentación de .NET basado:

Tutorial on Sandcastle

Sandcastle Help File Builder (SHFB)
Tutorial on SHFB

Web Project Documentation
Tutorial on how to document Web Projects (Más manual y creo desfasado a raíz de la anterior enlace)

MSDN reference for XML Documentation

Answer 3

Doc Project produce documentos más pulidos, cuando funciona, que no todo el tiempo. Es un producto mucho más flakey.

Sandcastle Help File Builder es sólido y hace el trabajo bien.

Answer 4

No he usado DocProject pero parece ser un producto con capacidades comparables a Sandcastle.

He usado Sandcastle y lo encuentro una herramienta eficaz. También necesita Sandcastle Help File Builder (SHFB) para darle un buen front-end, como otros han mencionado aquí. Además, necesita Sandcastle Styles para los parches de la capa de presentación del motor Sandcastle. Si bien estos tres componentes tuvieron una nueva versión a mediados de 2010, estoy posponiendo la actualización de la versión 2008 debido a un defecto de procesamiento en Firefox 3.6 (documentado en la entrada 2010.09.06 de este defect report).

He documentado a fondo mi experiencia con la plataforma que describe ese problema y una variedad de otros que puede necesitar o querer considerar para producir un conjunto de documentación profesional y ordenada. Mi artículo "Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code" acaba de publicarse en el Simple-Talk.com en septiembre de 2010; puede ahorrar un poco de tiempo, esfuerzo y agonía :-).