Ich schrieb in Lala Land, als ich plötzlich ein 3'd '/' in einem Kommentar tippte. Ursprünglich ein Kommentar geht grün mit 2 '/' s :Was macht 3 '/ s in einer Reihe in C#?
Aber mit dem dritten Strich geht es grau '///' :
Hat das eine bestimmte Bedeutung? Oder hat es nur die Farbe gewechselt?
Es bezeichnet ein XmlComment, von denen mehr unter MSDN gelesen werden kann. Zum Beispiel
/// <summary>
/// Method summary - a method that does something
/// </summary>
/// <param name="i">Description of param</param>
/// <param name="s">Description of param</param>
/// <returns>An object of some sort or other</returns>
public object AMethod(int i, string s)
{
}
Edit: wie unten vorgeschlagen, sondern bietet auch IntelliSense Führung, wie das Bild unten zeigt.
Vielleicht ist es erwähnenswert, dass neben der Erstellung von Dokumentation, diese auch Details für Intellisense Popups in Visual Studio bieten. –
Gute Idee, habe hinzugefügt. – glosrob
Schön gemacht auch. Obwohl, wie Sie mit diesem Farbschema arbeiten ...;) –
Drei-slash Kommentare sind für die Dokumentation Builder. Sie können die Dokumentation Ihrer APIs direkt von der Quelle generieren. Sie können dokumentieren, was Ihre API tut, welche Parameter sie benötigt, welche Ausnahmen sie auslöst, usw. direkt in Ihrer Quelle. Microsoft stellt Tools zur Verfügung, mit denen Sie überprüfen können, ob Ihre Dokumentation mit der tatsächlichen API synchronisiert ist. Wenn Sie beispielsweise einen Parameter hinzufügen, entfernen oder umbenennen, aber vergessen, die Änderung zu dokumentieren, erhalten Sie eine Warnung.
So generieren Sie Dokumentation aus diesen Tags mit Visual Studio: link.
/// ist für XML-Kommentar. Es bietet einen XML-formatierten Kommentar. Sie können auch XML-Dokument von diesem erstellen, indem Sie die /doc: Optionen während des Kompilierens von diesem wie
verwenden Natürlich ist '///' nur über die Farbe. So wie '' '' ist es, die Dinge rot zu machen ;-) – Joey