Génération automatique de la documentation sur les fonctions dans Visual Studio

Question

Je me demandais s'il existait un moyen (heureusement un raccourci clavier) de créer des en-têtes de génération automatique dans Visual Studio.

Exemple:

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

Et cela deviendrait automatiquement quelque chose comme ça ...

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

Answer 1

Faites que "trois marqueurs de commentaire simples"

En C # c'est ///

qui par défaut crache:

/// <summary>
/// 
/// </summary>
/// <returns></returns>

Voici quelques conseils pour l'édition de modèles de VS .

Answer 2

GhostDoc !

Cliquez avec le bouton droit de la souris sur la fonction, sélectionnez "Documenter cela". et

private bool FindTheFoo(int numberOfFoos)

devient

/// <summary>
/// Finds the foo.
/// </summary>
/// <param name="numberOfFoos">The number of foos.</param>
/// <returns></returns>
private bool FindTheFoo(int numberOfFoos)

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

Il prend en charge C #, VB.NET et C / C ++. Il est par défaut associé à Ctrl + Maj + D .

N'oubliez pas: vous devez ajouter des informations autres que la signature de la méthode à la documentation. Ne vous arrêtez pas à la documentation générée automatiquement. Un outil comme celui-ci présente l'avantage de générer automatiquement la documentation pouvant être extraite de la signature de la méthode. Par conséquent, toutes les informations que vous ajoutez doivent être nouvelles .

Cela étant dit, je préfère personnellement lorsque les méthodes sont totalement auto-documentées, mais vous aurez parfois des normes de codage qui imposeront une documentation externe, puis un outil comme celui-ci vous épargnera beaucoup de frappe.

Answer 3

///

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

Puis, au-dessus du nom de la fonction, tapez simplement ///

et vous l'obtiendrez automatiquement

Answer 4

Visual Assist propose une solution intéressante , qui est extrêmement rentable.

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 paramètres par défaut, c'est un peu différent.)

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

Answer 5

Normalement, Visual Studio le crée automatiquement si vous ajoutez trois marqueurs de commentaire uniques au-dessus de l'élément que vous souhaitez 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 # - > Options avancées

et vérifiez

  

Générer des commentaires sur la documentation XML pour ///

Answer 6

Dans Visual Basic, si vous créez d’abord votre fonction / sous-requête, puis sur la ligne située au-dessus de celle-ci, vous tapez 'trois fois, le code XML approprié sera généré automatiquement pour la documentation. Cela apparaît également lorsque vous passez la souris dans IntelliSense et lorsque vous utilisez la fonction.

Answer 7

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

De même, si vous tapez trois guillemets simples ('' ') sur la ligne située au-dessus de l'en-tête de la fonction, le modèle d'en-tête XML que vous pourrez remplir sera inséré.

Ces commentaires XML peuvent être interprétés par le logiciel de documentation et sont inclus dans la sortie de la construction en tant que 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.

Answer 8

Je travaille sur un projet open-source appelé Todoc, qui analyse les mots pour produire automatiquement la documentation appropriée lors de la sauvegarde d'un fichier. Il respecte les commentaires existants et est très rapide et fluide.

http://todoc.codeplex.com/