Udostępnij za pośrednictwem

CodeComment.DocComment Właściwość

  • Odwołanie

Definicja

Przestrzeń nazw:
System.CodeDom
Zestaw:
System.CodeDom.dll
Zestaw:
System.dll
Pakiet:
System.CodeDom v6.0.0
Pakiet:
System.CodeDom v7.0.0
Pakiet:
System.CodeDom v8.0.0
Pakiet:
System.CodeDom v9.0.0-preview.2.24128.5
Źródło:
CodeComment.cs
Źródło:
CodeComment.cs
Źródło:
CodeComment.cs

Pobiera lub ustawia wartość wskazującą, czy komentarz jest komentarzem do dokumentacji.

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

Wartość właściwości

Boolean

true jeśli komentarz jest komentarzem do dokumentacji; w przeciwnym razie , false.

Uwagi

Niektóre języki obsługują specjalny typ komentarza, który można automatycznie wyodrębnić z kodu źródłowego na potrzeby dokumentacji. Tej właściwości można użyć do określenia, czy komentarz jest komentarzem dokumentacji, który może wygenerować inną składnię. Przykładem jest język C#, który używa znaku "//" do zwykłych komentarzy i "///" w przypadku komentarzy do dokumentacji.

Dotyczy