Quelle est la différence entre // et /// dans Visual Studio?

Question

Stylecop me dit d'utiliser /// au lieu de // quand je commente. Quelle est la différence sémantique pour ces deux et quand dois-je utiliser lequel?

Answer 1

// indique vos propres commentaires personnels, où /// dénote les commentaires pouvant contenir des données spéciales, p.ex. balisage pour l'interprétation par Visual Studio - comme:

/// <summary> 
/// This class does something. 
/// </summary> 
class Bob { 
    ... 
} 

Cela indiquera Visual Studio le résumé de la classe Bob, et qui sera ensuite affiché dans votre boîte de complétion de code.

Answer 2

Je l'ai trouvé moi-même en passant par d'autres règles StyleCop:

Utilisez // lorsque commentin

Utilisez /// lors de la documentation pour les en-têtes de documentation XML

Answer 3

La barre oblique triple vous donne un modèle généré automatiquement avec des paramètres et d'autres caractéristiques, il automatiquement pour vous

/// <summary> 
/// Here is your comment 
/// </summary> 
/// <param name="sender">parameter generated automatically</param> 
/// <param name="e">as above</param> 
void BindableCollection_CollectionChanged(object sender, NotifyCollectionChangedEventArgs e) 

Cette approche signifie qu'un outil tel que NDoc peut alors chaluter votre source pour créer des fichiers de documentation automagiquement. Le double slash ne le coupe pas ...

Answer 4

Il n'y a pas de différence sémantique, c'est juste un style de codage ou de commentaire. .NET arrive à choisir cela pour les commentaires. Il est généralement utile de suivre ces règles pour les outils de documentation de code automatique comme sandcastle.

Par exemple Doxygen a un style de commentaire complètement différent pour le code C++. Donc, c'est principalement pour la cohérence et les normes