CodeComment.DocComment Vlastnost

Definice

Obor názvů:

System.CodeDom

Sestavení:

System.CodeDom.dll

Balíček:

System.CodeDom v8.0.0

Zdroj:

CodeComment.cs

Získá nebo nastaví hodnotu, která označuje, zda komentář je dokumentační komentář.

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

Hodnota vlastnosti

Boolean

truepokud komentář je dokumentační komentář; v opačném případě . false

Poznámky

Některé jazyky podporují speciální typ komentáře, který se dá automaticky extrahovat ze zdrojového kódu pro účely dokumentace. Tato vlastnost se dá použít k určení, jestli je komentář dokumentačním komentářem, který může generovat jinou syntaxi. Příkladem je jazyk C#, který používá "//" pro běžné komentáře a /// pro komentáře dokumentace.