CodeComment.DocComment Eigenschap
Definitie
Belangrijk
Bepaalde informatie heeft betrekking op een voorlopige productversie die aanzienlijk kan worden gewijzigd voordat deze wordt uitgebracht. Microsoft biedt geen enkele expliciete of impliciete garanties met betrekking tot de informatie die hier wordt verstrekt.
Hiermee wordt een waarde opgehaald of ingesteld die aangeeft of de opmerking een documentatie-opmerking is.
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
Waarde van eigenschap
true als de opmerking een documentatie-opmerking is; anders, false.
Opmerkingen
Sommige talen ondersteunen een speciaal type opmerking dat automatisch uit de broncode kan worden geëxtraheerd voor documentatiedoeleinden. Deze eigenschap kan worden gebruikt om aan te geven of de opmerking een documentatie-opmerking is, die een andere syntaxis kan genereren. Een voorbeeld hiervan is C#, dat gebruikmaakt van '//' voor reguliere opmerkingen en '///' voor documentatieopmerkingen.