CodeComment.DocComment Propiedad

Definición

Espacio de nombres:

System.CodeDom

Ensamblado:

System.CodeDom.dll

Paquete:

System.CodeDom v8.0.0

Source:

CodeComment.cs

Obtiene o establece un valor que indica si el comentario es de documentación.

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

Valor de propiedad

Boolean

true si el comentario es de documentación; en caso contrario, false.

Comentarios

Algunos idiomas admiten un tipo especial de comentario que se puede extraer automáticamente del código fuente con fines de documentación. Esta propiedad se puede usar para designar si el comentario es un comentario de documentación, que puede generar una sintaxis diferente. Un ejemplo de esto es C#, que usa "//" para comentarios regulares y "///" para los comentarios de documentación.