studio - sand castle c#
DocProject vs Sandcastle Help File Builder GUI (4)
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 del documento del proyecto 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 usando el visor de Ayuda 2)
Puedo responder 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 de C # y luego tener un proyecto maestro de construcción que documente todo.
Aquí hay algunos enlaces útiles para la documentación de .NET basada en Sandcastle:
Sandcastle Help File Builder (SHFB)
Tutorial sobre SHFB
Documentación del proyecto web
Tutorial sobre cómo documentar proyectos web (más manual y creo que está desactualizado dado el enlace anterior)
Doc Project produce documentos más pulidos, cuando funciona, que no es todo el tiempo. Es un producto mucho más flakey.
Sandcastle Help File Builder es sólido y hace el trabajo.
No he usado DocProject pero parece ser un producto con capacidades comparables a Sandcastle.
He usado Sandcastle y creo que es una herramienta efectiva. También necesita Sandcastle Help File Builder (SHFB) para ofrecerle una buena interfaz, como han mencionado otros aquí. Además, necesita Sandcastle Styles para los parches de la capa de presentación del motor Sandcastle. Si bien los tres componentes tenían una nueva versión a mediados de 2010, estoy posponiendo la actualización de la versión 2008 debido a un defecto de renderizado en Firefox 3.6 (documentado en la entrada 2010.09.06 de este informe de defectos ).
He documentado minuciosamente mi experiencia con la plataforma que describe ese tema y una variedad de otros que puede necesitar o querer considerar para producir un conjunto de documentación ordenado y profesional. Mi artículo " Taming Sandcastle: una guía del programador de .NET para documentar su código " acaba de publicarse en Simple-Talk.com en septiembre de 2010; puede ahorrarle algo de tiempo, esfuerzo y agonía :-).