2008-10-08 27 views
16

Ich checke gerade F #, also Entschuldigung, wenn das eine dumme Frage ist, aber in der VS2008 F # CTP 1.9.6.2 'Tutorial' Projekt, sowohl // und /// werden für das Kommentieren von Code verwendet..NET // vs /// Kommentare Konvention

Gibt es einen funktionalen Unterschied zwischen den zwei Schrägstrich vs drei Schrägstrich kommentieren, oder ist es Konvention (wie es im Tutorial-Code erscheint), eine Funktion mit /// kommentieren und // für alles andere verwenden?

Antwort

33

Die Verwendung von drei Schrägstrichen (///) ist eine C# -Konvention für XML Documentation Comments, die auch von F # übernommen wird.

7

/// ist für Dokumentationskommentare. VS wird es beim Generieren von Intellisense-Informationen verwenden.

5

Es ist vergleichbar mit /* comment */ vs /** documented comment */ in Java.

Letzteres funktioniert genauso, wird aber von Dokumentationssoftware auch als Entwicklerdokumentation erkannt - nicht nur als Hinweis.

+4

Was hilft nur, wenn Sie wissen, was diese Kommentarkonstruktionen in Java tun, was nicht die Frage war. –