CodeComment.DocComment Tulajdonság

Definíció

Lekéri vagy beállít egy értéket, amely jelzi, hogy a megjegyzés dokumentációs megjegyzés-e.

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

Tulajdonság értéke

trueha a megjegyzés dokumentációs megjegyzés; egyéb esetben. false

Megjegyzések

Egyes nyelvek támogatnak egy speciális megjegyzéstípust, amely dokumentációs célból automatikusan kinyerhető a forráskódból. Ez a tulajdonság használható annak meghatározására, hogy a megjegyzés dokumentációs megjegyzés-e, ami más szintaxist eredményezhet. Ilyen például a C#, amely a "//" karaktert használja a normál megjegyzésekhez, a dokumentációs megjegyzésekhez pedig a "///"-t.

A következőre érvényes: