CodeComment.DocComment Vlastnost
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Získá nebo nastaví hodnotu, která označuje, zda komentář je komentář dokumentace.
public:
property bool DocComment { bool get(); void set(bool value); };public bool DocComment { get; set; }member this.DocComment : bool with get, setPublic Property DocComment As BooleanHodnota vlastnosti
truepokud je komentář dokumentačním komentářem; v opačném případě . false
Poznámky
Některé jazyky podporují speciální typ komentáře, který lze automaticky extrahovat ze zdrojového kódu pro účely dokumentace. Tuto vlastnost lze použít k určení, zda komentář je komentář dokumentace, který může generovat jinou syntaxi. Příkladem je jazyk C#, který pro komentáře dokumentace používá "//" pro běžné komentáře a ///.
