CodeComment.DocComment Egenskap

Definition

Hämtar eller anger ett värde som anger om kommentaren är en dokumentationskommentare.

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

Egenskapsvärde

trueom kommentaren är en dokumentationskommentare; annars . false

Kommentarer

Vissa språk stöder en särskild typ av kommentar som automatiskt kan extraheras från källkoden i dokumentationssyfte. Den här egenskapen kan användas för att ange om kommentaren är en dokumentationskommentare som kan generera en annan syntax. Ett exempel på detta är C#, som använder "//" för vanliga kommentarer och "///" för dokumentationskommentar.

Gäller för