2009-01-02 10 views
1

Où puis-je trouver un plug-in Visual Studio qui génère automatiquement un en-tête de documentation pour les méthodes et les propriétés?Ajout automatique de commentaires de code .Net

Exemple le commentaire à une propriété pourrait ressembler à ceci:

/// <summary> 
/// Gets or sets the value of message 
/// </summary> 
public static string Message   
{ 
    get 
    { 
     return message; 
    } 

    set 
    { 
     message = value; 
    } 
} 
+0

Ce commentaire est-il réellement utile à tout le monde? –

+0

Oui, je préfèrerais n'avoir aucun commentaire à faire. S'il n'y a pas de commentaire pour la méthode, au moins vous savez que vous voudrez peut-être revenir en arrière et en ajouter un. –

+0

Mon sentiment exactement. Un de mes collègues est obligé d'utiliser StyleCop et cette foutue chose trouve des erreurs dans n'importe quoi, même dans la documentation de l'en-tête de la méthode des événements, donc elle a besoin d'une certaine automatisation. – Germstorm

Répondre

4

GhostDoc est le suspect d'habitude.

Comme une autre affiche mentionnée, Visual Studio le fait également dans une certaine mesure en entrant 3 '///' (barres obliques) sur la ligne précédant une définition de propriété/méthode/classe.

3

Visual Studio le fait automatiquement. Il suffit de positionner le curseur directement au-dessus de la méthode et entrez trois par exemple l «/» :

using System; 
using System.Collections.Generic; 
using System.Linq; 
using System.Web; 

namespace MvcWidgets.Models 
{ 
    /// <summary> 
    /// This is a summary comment 
    /// </summary> 
    public class Comment 
    { 
     /// <summary> 
     /// 
     /// </summary> 
     /// <param name="name"></param> 
     /// <param name="birthdate"></param> 
     /// <param name="website"></param> 
     /// <returns></returns> 
     public int SomeMethod(string name, DateTime birthdate, Uri website) 
     { 
      return 0; 
     } 
    } 
} 

Vous pouvez ensuite générer un fichier de commentaire XML et générer un fichier d'aide en utilisant SandCastle.

Vous devrez peut-être activer cette fonctionnalité dans la boîte de dialogue Options de l'éditeur de texte/C#/Avancé.

+0

C'est vrai, mais GhostDoc peut faire des choses supplémentaires. – M4N

+0

Je connais la chose ///, ce dont j'ai besoin est le remplissage (= ce que fait Ghost Doc) – Germstorm

+0

Merci pour ça! – Jason

Questions connexes