Jaka jest różnica między // i /// w Visual Studio?

Question

Stylecop mówi mi, aby używać /// zamiast // podczas komentowania. Jaka jest różnica semantyczna dla tych dwojga i kiedy powinienem użyć której?

Answer 1

// oznacza własne komentarze osobiste, gdzie /// oznaczają komentarze, które mogą zawierać dane specjalne, np znaczników do interpretacji przez Visual Studio - jak:

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

to powie Visual Studio podsumowanie klasy Bob, a następnie pojawi się w polu kod zakończenia.

Answer 2

Znaleziona się podczas przechodzenia przez dalsze zasady StyleCop:

użytkowania // gdy commentin

Korzystając /// podczas dokumentowania dla nagłówków dokumentacji XML

Answer 3

Potrójna ukośnik daje automatycznie wygenerowanego szablonu z parametrów i innych funkcji automatycznie dla ciebie

/// <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) 

Takie podejście oznacza, że ​​narzędzie takie jak NDoc można następnie włoka źródło do tworzenia dokumentacji plików automagicznie. Double slash po prostu go nie wycina ...

Answer 4

Nie ma różnicy semantycznej, to tylko styl kodowania lub komentowania. .NET zdarza się wybrać to dla komentarzy. Ogólnie pomocne jest przestrzeganie tych zasad w przypadku narzędzi do automatycznej dokumentacji kodu, takich jak sandcastle.

Na przykład Doxygen ma zupełnie inny styl komentowania dla kodu C++. Tak więc jest to głównie dla spójności i standardów