CodeComment.DocComment Proprietà

Definizione

Spazio dei nomi:

System.CodeDom

Assembly:

System.CodeDom.dll

Pacchetto:

System.CodeDom v8.0.0

Origine:

CodeComment.cs

Ottiene o imposta un valore che indica se il commento è relativo alla documentazione.

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

Valore della proprietà

Boolean

true se il commento è un commento relativo alla documentazione; in caso contrario false.

Commenti

Alcuni linguaggi supportano un tipo speciale di commento che può essere estratto automaticamente dal codice sorgente a scopo di documentazione. Questa proprietà può essere usata per designare se il commento è un commento della documentazione, che può generare una sintassi diversa. Un esempio di questo è C#, che usa "//" per i commenti regolari e "//" per i commenti della documentazione.