CodeComment.DocComment Właściwość
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
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
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.