CodeComment.DocComment Propriété

Définition

Espace de noms:

System.CodeDom

Assembly:

System.CodeDom.dll

Paquet:

System.CodeDom v8.0.0

Source:

CodeComment.cs

Obtient ou définit une valeur qui indique si le commentaire est un commentaire de la documentation.

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

Valeur de propriété

Boolean

true si le commentaire est un commentaire de la documentation ; sinon, false.

Remarques

Certains langages prennent en charge un type spécial de commentaire qui peut être extrait automatiquement du code source à des fins de documentation. Cette propriété peut être utilisée pour indiquer si le commentaire est un commentaire de documentation, ce qui peut générer une syntaxe différente. C#, par exemple, utilise « / / » pour les commentaires réguliers et « /// » pour les commentaires de documentation.