Génération automatique de la documentation de la fonction dans Visual Studio

Je me demandais s’il y avait un moyen (j’espère que le raccourci clavier) pour créer des en-têtes de fonction de génération automatique dans Visual Studio.

Exemple:

Private Function Foo(ByVal param1 As Ssortingng, ByVal param2 As Integer) 

Et ça deviendrait automatiquement quelque chose comme ça …

 '---------------------------------- 'Pre: 'Post: 'Author: 'Date: 'Param1 (Ssortingng): 'Param2 (Integer): 'Summary: Private Function Foo(ByVal param1 As Ssortingng, ByVal param2 As Integer) 

Faites en sorte que “trois simples marqueurs de commentaire”

En C # c’est ///

qui par défaut crache:

 ///  /// ///  ///  

Voici quelques conseils sur la modification des modèles VS.

GhostDoc !

Cliquez-droit sur la fonction, sélectionnez “Document this” et

 private bool FindTheFoo(int numberOfFoos) 

devient

 ///  /// Finds the foo. ///  /// The number of foos. ///  private bool FindTheFoo(int numberOfFoos) 

(oui, tout est généré automatiquement).

Il prend en charge C #, VB.NET et C / C ++. Il est mappé par défaut sur Ctrl + Shift + D.

Rappelez-vous: vous devez append des informations au-delà de la signature de la méthode à la documentation. Ne vous contentez pas de vous arrêter avec la documentation générée automatiquement. La valeur d’un outil comme celui-ci est qu’il génère automatiquement la documentation qui peut être extraite de la signature de la méthode. Toute information que vous ajoutez doit donc être nouvelle .

Cela étant dit, je préfère personnellement quand les méthodes sont totalement autodocumentées, mais parfois vous aurez des normes de codage qui requièrent une documentation externe, et un outil comme celui-ci vous permettra d’économiser beaucoup de frappe.

 /// 

est le raccourci pour obtenir le bloc de commentaires Method Description. Mais assurez-vous d’avoir écrit le nom et la signature de la fonction avant de l’append. Commencez par écrire le nom et la signature de la fonction.

Ensuite, au-dessus du nom de la fonction, tapez ///

et vous l’obtiendrez automatiquement

entrer la description de l'image ici

Visual Assist a également une bonne solution et est hautement personnalisable.

Après l’avoir modifié pour générer des commentaires de style doxygen, ces deux clics produiraient –

 /** * Method: FindTheFoo * FullName: FindTheFoo * Access: private * Qualifier: * @param int numberOfFoos * @return bool */ private bool FindTheFoo(int numberOfFoos) { } 

(Sous les parameters par défaut, c’est un peu différent.)


Modifier: La manière de personnaliser le texte de la «méthode de document» est sous VassistX-> Options d’assistance visuelle-> Suggestions, sélectionnez «Modifier les extraits de code VA», Langue: C ++, Type: Refactoring, puis sélectionnez «Méthode de document». L’exemple ci-dessus est généré par:

va_doxy

Normalement, Visual Studio le crée automatiquement si vous ajoutez trois simples marqueurs de commentaire au-dessus de la chose que vous aimez commenter (méthode, classe).

En C # ce serait /// .

Si Visual Studio ne le fait pas, vous pouvez l’activer dans

Options-> Editeur de texte-> C # -> Avancé

et vérifie

Générer des commentaires de documentation XML pour ///

description photo

En Visual Basic, si vous créez d’abord votre fonction / sous-titre, puis sur la ligne située au-dessus, vous tapez trois fois, cela générera automatiquement le fichier XML approprié pour la documentation. Cela apparaît également lorsque vous passez la souris sur intellisense et lorsque vous utilisez la fonction.

Vous pouvez utiliser des extraits de code pour insérer les lignes de votre choix.

En outre, si vous tapez trois guillemets simples (” ‘) sur la ligne au-dessus de l’en-tête de la fonction, il insérera le modèle d’en-tête XML que vous pourrez ensuite remplir.

Ces commentaires XML peuvent être interprétés par un logiciel de documentation et sont inclus dans la sortie de génération sous la forme d’un fichier assembly.xml. Si vous conservez ce fichier XML avec la DLL et référencez cette DLL dans un autre projet, ces commentaires deviennent disponibles dans intellisense.

Je travaille sur un projet open-source appelé Todoc qui parsing les mots pour produire automatiquement une documentation correcte lors de l’enregistrement d’un fichier. Il respecte les commentaires existants et est très rapide et fluide.

http://todoc.codeplex.com/