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

Question

Necesito escribir un archivo de ayuda para una aplicación WinForms en Visual Studio 2010. Idealmente, me gustaría usar una herramienta que se integre con Visual Studio, en lugar de una herramienta totalmente separada.

En el pasado he usado HTML Help Workshop, pero esto es antiguo, y recuerdo que fue un poco raro de usar. También sé que había una herramienta integrada en el SDK de Visual Studio 2005, pero necesito algo para el 2010.

Answer 1

es un objetivo difícil para los proveedores de herramientas. En la mayoría de las tiendas, la ayuda está escrita por escritores profesionales que no tienen ningún uso para Visual Studio en sus actividades diarias. Las herramientas de autoría de terceros como RoboHelp son su arma favorita.

La herramienta VSK del VS2005 que probablemente vio fue HelpStudio Lite, un producto de Innovasys. No hay una versión disponible que se integre con VS2010 y, a juzgar por un forum post, no tienen intención de lanzar una. Su documento X! producto sin embargo, suena como lo que debería echarle un vistazo. La versión eval está disponible para descargar from here.

Answer 2

Probablemente no se integre con VS2010, pero recuerdo haber usado RoboHelp en el 97 y estaba bien: entonces entonces sí si tuviera que escribir archivos de ayuda ahora, probablemente le daría otra mirada, ya que parece que todavía está alrededor de here. Aunque parece bastante caro, pero si tiene algunas licencias de Adobe (que no es totalmente inusual para una tienda de desarrollo) por alguna otra razón, ¿quizás ya lo tiene?

Answer 3

Recuerdo que hace aproximadamente un año algunas personas en el foro de Joel's Business of Software estaban recomendando HelpNDoc.

Foro de discusión: http://discuss.joelonsoftware.com/default.asp?biz.5.359131.10

Answer 4

Estas son las opciones ...

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

• Sandcastle Help File Builder para la generación de archivo de ayuda
• DocProject para integrarlo en VS

Aunque parece que DocProject doesn't quite support VS2010 yet.

Para la solución no-MS no GhostDoc, lo que hace apoyo 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 5

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

/// <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

Un más El generador de ayuda, rico en características, que integra con Visual Studio 2010 y genera múltiples formatos de ayuda es VSDocMan. Incluye un editor de comentarios WYSIWYG, y en realidad comenta algunos de sus códigos por usted. Extremadamente útil

Answer 6

Ayuda HTML, se sustituye por la Ayuda HTML 2.

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

Answer 7

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.

Answer 8

ghost doc with documentx o sandcastle es el camino a seguir ... El descanso sigue siendo muy primitivo cuando se trata de 2010. Si tiene proyecto tanto C# como C++ entonces documentx será el camino si es solo C# y luego cualquier uno es bueno

Answer 9

Si la audiencia de su archivo de ayuda es el usuario de la aplicación html help 2 no se puede usar, igualmente deberá crear un archivo chm. La herramienta que puede hacer esto desde la aplicación winforms es Help Generator for Visual Studio, lo que quita mucho trabajo al preparar la ayuda y vincularla a los formularios.