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

Question

Je me demandais s'il existe un moyen (avec un peu de chance, un raccourci clavier) de créer des en-têtes de fonction générés automatiquement dans Visual Studio.

Exemple :

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

Et ça 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

Disons "trois marqueurs de commentaires".

En C#, c'est ///

qui par défaut crache :

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

Voici quelques conseils sur l'édition des modèles VS.

Answer 2

GhostDoc !

Cliquez avec le bouton droit de la souris sur la fonction, sélectionnez "Documenter ceci" 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 mappé sur Ctrl + Shift + D .

N'oubliez pas : vous devez ajouter à la documentation des informations autres que la signature de la méthode. Ne vous contentez pas de 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, donc toute information que vous ajoutez doit être nouveau informations.

Ceci étant dit, je préfère personnellement que les méthodes soient totalement auto-documentées, mais il arrive parfois que des normes de codage imposent une documentation externe, et un outil comme celui-ci vous évitera de taper dans le vide.

Answer 3

Visual Assist dispose d'un bonne solution aussi, et est hautement costumable.

Après l'avoir modifié pour qu'il génère 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 façon de personnaliser le texte de la 'méthode du document' est sous VassistX->Options d'assistance visuelle->Suggestions, sélectionnez 'Edit VA Snippets', Language : C++, Type : Refactoring, puis allez à 'Document Method' et personnalisez. L'exemple ci-dessus est généré par :

Answer 4

En Visual Basic, si vous créez d'abord votre fonction/sous-fonction, puis que vous tapez trois fois ' sur la ligne au-dessus, le système générera automatiquement le fichier xml correspondant pour la documentation. Cela apparaît également lorsque vous passez la souris dans intellisense, et lorsque vous utilisez la fonction.

Answer 5

Vous pouvez utiliser des extraits de code pour insérer les lignes que vous souhaitez.

En outre, si vous tapez trois guillemets simples (''') sur la ligne au-dessus de l'en-tête de la fonction, le modèle d'en-tête XML que vous pouvez ensuite remplir sera inséré.

Ces commentaires XML peuvent être interprétés par un logiciel de documentation et sont inclus dans le résultat de la construction sous la forme d'un fichier assembly.xml. Si vous conservez ce fichier XML avec la DLL et que vous faites référence à cette DLL dans un autre projet, ces commentaires deviennent disponibles dans intellisense.