CodeEvent.Comment (Propiedad)

Artículo
08/10/2011

Obtiene o establece un comentario de encabezado asociado al elemento de evento de código.

Espacio de nombres: EnvDTE80
Ensamblado: EnvDTE80 (en EnvDTE80.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 contiene un comentario de encabezado o una cadena vacía si no se proporciona ningún comentario.

Comentarios

El texto recuperado no contiene ninguna sintaxis de comentario. El texto se deriva del origen basado en el estilo de comentario del lenguaje. Por ejemplo, en C#, el delimitador de comentario es //, pero en Visual Basic es un apóstrofo (') o Rem (abreviatura de "remark", que significa comentario en inglés).

Cuando se establece, la propiedad Comment intenta mantener el estilo de los comentarios existentes utilizando sintaxis orientada a la línea frente a la delimitada. En el proceso, mantiene las sangrías antes que la sintaxis orientada a la línea determinando si el comentario toca el elemento de código o si está separado por una línea en blanco.

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).

Ejemplos

En el siguiente ejemplo se muestra cómo se utiliza la propiedad Comment.

Para probar esta propiedad:

Abra el proyecto de destino y seleccione el elemento de evento de código situando el cursor en el objeto de evento pertinente.
Ejecute el complemento.

public static void Comment(EnvDTE80.DTE2 dte)
{
    TextSelection objTextSel;
    EnvDTE80.CodeEvent codeEvent;
    objTextSel = (TextSelection)dte.ActiveDocument.Selection;
    codeEvent = (EnvDTE80.CodeEvent)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementEvent);

    MessageBox.Show("\nComment property: " +
                    codeEvent.Comment, "Testing CodeEvent");
}

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.