CodeFunction.Comment (Propiedad)

Artículo
08/10/2011

Obtiene o establece el comentario asociado al elemento de código.

Espacio de nombres: EnvDTE
Ensamblado: EnvDTE (en EnvDTE.dll)

Sintaxis

'Declaración
Property Comment As String
    Get
    Set

string Comment { get; set; }

property String^ Comment {
    String^ get ();
    void set (String^ value);
}

abstract Comment : string with get, set

function get Comment () : String
function set Comment (value : String)

Valor de propiedad

Tipo: System.String
Una cadena que representa el comentario asociado al elemento de código.

Comentarios

Comment establece o devuelve el comentario del encabezado. Cuando se devuelve, el texto no contiene ninguna sintaxis de comentario.

El texto del comentario se deriva del documento de origen que contiene el elemento de código. El número de líneas de comentario del encabezado variará dependiendo del lenguaje en el que se hayan escrito dichos comentarios.

Una vez establecido, Comment intentará mantener el estilo de los comentarios existentes utilizando una sintaxis delimitada frente a otra orientada a líneas, manteniendo las sangrías anteriores a la sintaxis orientada a líneas, determinando si el comentario toca el elemento de código o está separado por una línea en blanco, etc.

Nota

Los valores de los elementos de modelo de código como clases, structs, funciones, atributos, delegados, etc., pueden ser no deterministas una vez realizados determinados tipos de modificaciones; esto significa que no se puede confiar en que sus valores se mantengan siempre igual. Para obtener más información, vea la sección Los valores de elementos de modelo de código pueden cambiar, en Detectar código utilizando el modelo de código (Visual Basic).

Seguridad de .NET Framework

Plena confianza para el llamador inmediato. Un código de confianza parcial no puede utilizar este miembro. Para obtener más información, vea Utilizar bibliotecas de código que no es de plena confianza.