Quels sont les outils disponibles pour créer un fichier d'aide dans Visual Studio 2010?

Question

Je dois écrire un fichier d'aide pour une application WinForms dans Visual Studio 2010. Idéalement, je voudrais utiliser un outil qui intègre avec Visual Studio, plutôt que d'un outil totalement distinct.

Dans le passé, je l'ai utilisé HTML Help Workshop, mais est ancienne, et je me souviens qu'il était un peu funky à utiliser. Je sais aussi qu'il y avait un outil intégré dans le kit de développement Visual Studio 2005, mais je besoin de quelque chose pour 2010.

Answer 1

il est une cible gênant pour les fournisseurs d'outils. Dans la plupart des magasins, l'aide est rédigé par des écrivains professionnels qui n'ont aucune utilité pour Visual Studio dans leurs activités au jour le jour. outils de création de tiers comme RoboHelp est leur arme préférée de choix.

L'outil SDK VS2005 vous avez probablement vu était HelpStudio Lite , un produit de Innovasys. Il n'y a pas de version disponible qui intègre avec VS2010 et à en juger à partir d'un post sur le forum ils ont pas l'intention de libérer un. Leur document X! produit ne cependant, ressemble à ce que vous devez jeter un oeil à. La version eval est disponible en téléchargement d'ici .

Answer 2

Voici vos options ...

Si vous voulez que le générateur de documentation de Microsoft avec l'intégration VS:

• Sandcastle Aide Générateur de fichiers pour la génération de fichiers d'aide
• DocProject pour l'intégrer dans VS

Bien, il semble que DocProject ne supporte pas tout à fait VS2010 encore .

Pour la solution non-MS, il est GhostDoc qui fait soutien à l'intégration VS 2010 et semble être une meilleure solution.

Pour les options qui ne s'intègre pas dans Visual Studio:

• Doxygen
• Docu
• NDoc3

Answer 3

Je me souviens un an il y a certaines personnes sur le forum d'affaires du logiciel de Joel recommandaient HelpNDoc .

Forum de discussion: http://discuss.joelonsoftware.com/default. asp? biz.5.359131.10

Answer 4

Comme d'autres l'ont dit, vous pouvez convertir l'aide XML slash triple style MSDN utilisant Sandcastle tous les membres au niveau de la classe et les objets

/// <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){
...

Voici le lien vers Sandscastle

plus riche en fonctionnalités générateur d'aide que intègre à Visual Studio 2010 et génère de multiples formats d'aide est VSdocman . Il inclut un éditeur de commentaires WYSIWYG, et commente en fait pour vous une partie de votre code. Extrêmement utile

Answer 5

fantôme doc avec Documentx ou Sandcastle est la voie à suivre ... Le repos est tout encore très primitif quand il vient à 2010. Si vous avez des projets C # et C ++, puis sera Documentx le chemin si son juste C # puis une est bon.

Answer 6

Si le public pour votre fichier d'aide est l'utilisateur de l'application HTML aide 2 n'est pas utilisable, il vous faut encore créer un fichier CHM. L'outil qui peut le faire pour votre depuis votre application WinForms est Help Generator pour Visual studio, ce qui enlève beaucoup de travail dans la préparation de l'aide et de le lier aux formes.

Answer 7

Probablement n'intègre pas VS2010 mais je me souviens à l'aide RoboHelp en arrière autour '97 et il était correct: ish alors si je devais écrire helpfiles d'maintenant, je lui donnerais sans doute qu'un autre regard, car il semble que c'est toujours là < a href = "http://www.adobe.com/products/robohelp/" rel = "nofollow noreferrer"> ici . Assez cher mais il semble, mais si vous avez des licences Adobe (ce qui est pas tout à fait inhabituel pour un magasin de développement) pour une autre raison peut-être vous avez déjà cela?

Answer 8

Html Aide, est remplacé par Html Aide 2.

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

Answer 9

Juste fait beaucoup de recherches et après avoir testé divers outils http://www.helpgenerator.com/ est le meilleur moyen de mettre en place un système d'aide.