CodeComment.DocComment Eigenschaft

Definition

Namespace:

System.CodeDom

Assembly:

System.CodeDom.dll

Paket:

System.CodeDom v8.0.0

Quelle:

CodeComment.cs

Ruft einen Wert ab, der angibt, ob es sich bei dem Kommentar um einen Dokumentationskommentar handelt, oder legt diesen fest.

public:
 property bool DocComment { bool get(); void set(bool value); };

public bool DocComment { get; set; }

member this.DocComment : bool with get, set

Public Property DocComment As Boolean

Eigenschaftswert

Boolean

true, wenn es sich bei dem Kommentar um einen Dokumentationskommentar handelt, andernfalls false.

Hinweise

Einige Sprachen unterstützen einen speziellen Kommentartyp, der zu Dokumentationszwecken automatisch aus dem Quellcode extrahiert werden kann. Diese Eigenschaft kann verwendet werden, um anzugeben, ob es sich bei dem Kommentar um einen Dokumentationskommentar handelt, der möglicherweise eine andere Syntax generiert. Ein Beispiel hierfür ist C#, das "//" für regelmäßige Kommentare und "///" für Dokumentationskommentare verwendet.