CodeComment.DocComment Eigenschaft

Definition

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob der Kommentar ein Dokumentationskommentar ist.

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

truewenn der Kommentar ein Dokumentationskommentar ist; andernfalls . false

Hinweise

Einige Sprachen unterstützen einen speziellen Kommentartyp, der automatisch aus dem Quellcode für Dokumentationszwecke extrahiert werden kann. Diese Eigenschaft kann verwendet werden, um festzulegen, 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 reguläre Kommentare und "///" für Dokumentationskommentare verwendet.

Gilt für: