¿Qué herramientas están disponibles para crear un archivo de ayuda en Visual Studio 2010?

Question

Tengo que escribir un archivo de ayuda para una aplicación Windows Forms en Visual Studio 2010. Idealmente, me gustaría utilizar una herramienta que se integra con una herramienta totalmente separada de Visual Studio, en lugar de.

En el pasado he utilizado HTML Help Workshop, pero esto es muy antigua, y recuerdo que era un poco raro para su uso. También sé que había una herramienta integrada en el Visual Studio 2005 SDK, pero necesito algo para el año 2010.

Answer 1

es un objetivo difícil para los proveedores de herramientas. En la mayoría de las tiendas, la ayuda está escrito por escritores profesionales que no tienen ningún uso para Visual Studio en sus actividades del día a día. Terceros herramientas de autor como RoboHelp es su arma preferida de elección.

La herramienta VS2005 SDK es probable que vi fue HelpStudio Lite , un producto de Innovasys. No hay una versión disponible que se integra con VS2010 y juzgando por un mensaje del foro que no tienen intención de liberar uno. Su Documento X! Sin embargo, esto producto, suena como lo que se debe echar un vistazo a. La versión de evaluación se puede descargar de aquí .

Answer 2

Estas son las opciones ...

Si desea generador de documentación de Microsoft con la integración VS:

• Sandcastle Archivo de ayuda Constructor para la generación de archivo de ayuda
• DocProject para integrarlo en VS

Si bien, parece que DocProject no acaba de apoyar VS2010 sin embargo .

Para la solución no-MS hay GhostDoc , que hace soporte de VS 2010 y la integración parece ser una solución mejor.

Para opciones que no se integran en Visual Studio:

• Doxygen
• Docu
• NDoc3

Answer 3

Recuerdo que un año o así que hace que algunas personas en el negocio del foro Software de Joel recomendaban HelpNDoc .

Foro de debate: http://discuss.joelonsoftware.com/default. asp? biz.5.359131.10

Answer 4

Como otros han dicho, puede convertir la ayuda de triple barra XML de estilo de MSDN usando Castillo de arena en todos los miembros y los objetos de nivel de clase

/// <summary>
/// I am a method help Header
/// </summary>
/// <param name="parm1">info for param 1</param>
/// <param name="parm2">info for parm2</param>
/// <remarks>Some Extra Info</remarks>
public override void MeMethod(SourceElement rootElm, Subject subject){
...

Aquí está el enlace a Sandscastle

más rica en características generador que ayuda se integra con Visual Studio 2010 y genera múltiples formatos de ayuda es VSdocman . Incluye un editor WYSIWYG comentario, y de hecho comenta algunos de su código para usted. Extremadamente útil

Answer 5

doc fantasma con Documentx o castillo de arena es el camino a seguir ... El resto es todo aún muy primitiva cuando se trata de 2010. Si tiene proyectar C # y C ++ entonces Documentx será la forma si es sólo C # y luego cualquiera es bueno.

Answer 6

Si el público para su archivo de ayuda es el usuario de la aplicación HTML Help 2 no es utilizable, todavía tendrá que crear un archivo CHM. La herramienta que puede hacer esto para su aplicación a partir de sus winforms es Generador de Ayuda para visual Studio, que le quita mucho trabajo en la preparación de la ayuda y su vinculación con las formas.

Answer 7

Probablemente no se integra con VS2010 pero recuerdo usando RoboHelp la vuelta 97 y que estaba bien: ish continuación, por lo que si los archivos de ayuda que necesitaba para escribir ahora que probablemente le daría otra mirada, ya que parece que es todavía alrededor < a href = "http://www.adobe.com/products/robohelp/" rel = "nofollow noreferrer"> aquí . Bastante caro aunque parece pero si usted tiene algunas licencias de Adobe (que no es totalmente inusual para una tienda de desarrollo) por alguna otra razón tal vez usted ha conseguido ya esto?

Answer 8

Ayuda HTML, se sustituye por 2 Ayuda HTML.

http://www.mshelpwiki.com/wiki/tiki -index.php? page = Ayuda2

Answer 9

Sólo estado haciendo un gran trabajo de investigación y después de probar varias herramientas de la http://www.helpgenerator.com/ es la manera más rápida de armar un sistema de ayuda.