CodeComment.DocComment-Eigenschaft

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

Namespace: System.CodeDom
Assembly: System (in system.dll)

Syntax

'Declaration
Public Property DocComment As Boolean
'Usage
Dim instance As CodeComment
Dim value As Boolean

value = instance.DocComment

instance.DocComment = value

public bool DocComment { get; set; }

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

/** @property */
public boolean get_DocComment ()

/** @property */
public void set_DocComment (boolean value)

public function get DocComment () : boolean

public function set DocComment (value : boolean)

Eigenschaftenwert

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

Hinweise

Einige Sprachen unterstützen einen speziellen Kommentartyp, der für Dokumentationszwecke automatisch aus dem Quellcode extrahiert werden kann. Mit dieser Eigenschaft kann gekennzeichnet werden, ob es sich bei dem Kommentar um einen Dokumentationskommentar handelt, wodurch eine andere Syntax generiert werden kann. Dies gilt z. B. für C#. In dieser Sprache werden normale Kommentare mit "//" und Dokumentationskommentare mit "///" gekennzeichnet.

Plattformen

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

.NET Framework unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.

Versionsinformationen

.NET Framework

Unterstützt in: 2.0, 1.1, 1.0

Siehe auch

Referenz

CodeComment-Klasse
CodeComment-Member
System.CodeDom-Namespace