Y at-il quelque chose comme GhostDoc C ++

Question

Quand je développe en C #, j'utilise beaucoup GhostDoc pour accélérer le processus de commenter mon code. Je travaille actuellement sur un projet C ++ et je ne l'ai pas trouvé un outil équivalent. Je sais Doxygen, mais ce que je sais qu'il est utilisé pour créer des documents en dehors du code, pas des commentaires dans le code. Y a-t-il des bons outils équivalents? Je préférerais un qui fonctionne dans VS, mais je pouvais gérer un qui fonctionne dans tous les IDE.

(Avant que quelqu'un l'amène, je ne uniquement sur GhostDoc appuie ne pas créer de commentaires. Je viens de l'utiliser pour créer le point de départ de mes commentaires.)

Answer 1

Visual Assist aide en fournissant des scripts personnalisés exécutés lors de la frappe (ou autre).

Par exemple, vous pouvez avoir un script pour des commentaires comme celui-ci:

/************************************************************************/
/* My comment : $end$                                                                     */
/************************************************************************/

Ce serait proposé (via un combo-box exactement comme IntelliSense) lorsque vous commencez à taper « / ** » par exemple. Lorsque vous sélectionnez cette suggestion (via Entrée / Espace / Click - personnalisable), il insère le script dans lequel votre curseur est et il suffit de remplacer les marqueurs qui sont entre les caractères « $ » par des valeurs spéciales (comme le nom du fichier en cours par exemple). Voici la fin de $ marqueur $ fera le curseur soit dans cette position lorsque le script est exécuté. De cette façon, vous continuez à taper en douceur. Par exemple, avec l'ensemble de script précédent, en tapant exactement:

/** this is a test comment to show you one of the many features Visual Assit!

va simplement donner:

/************************************************************************/
/* My comment : this is a test comment to show you one of the many features Visual Assit!                                                                     */
/************************************************************************/

Il est vraiment facile de personnaliser et le comportement de la suggestion (lire: IntelliSense ++). Système est personnalisable

Answer 2

J'ai écrit un add-in, Atomineer Pro Documentation , ce qui est très similaire à GhostDoc (il génère / mises à jour des commentaires de documentation pour économiser beaucoup de temps et d'efforts pour documenter), mais il analyse le code directement pour lui-même et est donc capable de gérer C, C ++, C ++ / CLI, C #, Java et le code Visual Basic, et ne nécessite pas le code environnant pour être dans un état compilation avant cela fonctionnera. Il ajoute automatiquement / documentation mise à jour pour des choses plus délicates telles que les exceptions lancées dans le corps d'une méthode.

Il fonctionne sous Visual Studio 11, 2010, 2008 et 2005, et soutient la documentation-Xml, Doxygen, JavaDoc et Qt formats commentent, ainsi que le format / style de blocs de commentaires et les règles d'auto-doc utilisé étant hautement configurable . Il a un certain nombre d'autres fonctionnalités pratiques telles que les conversions d'aider des anciens doc-commentaires aux formats ci-dessus, et emballage mot doc-commentaires et commentaires de blocs normaux.

Ce qui précède est juste un résumé de certaines fonctionnalités clés - Cette comparaison de fonctionnalités avec d'autres produits sert une liste plus complète des nombreuses autres fonctionnalités disponibles.

Answer 3

Visual Assist peut faire le travail, mais je ne suis pas absolument sûr.