CodeClass2.Comment (Propiedad)

Artículo
05/17/2015

Establece u obtiene el comentario asociado a la clase de código.

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

Sintaxis

'Declaración
Property Comment As String

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: String
Cadena que representa el comentario.

Comentarios

Comment establece o devuelve el comentario del encabezado correspondiente a la clase. El texto devuelto 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, 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

[C#]

public void CodeClass2CommentExample(DTE2 dte2)
{
    // Before running this example, open a code document from a project
    // and place the insertion point within a class definition.
    try
    {   // Get the CodeClass2 at the insertion point.
        TextSelection sel = 
        (TextSelection)dte2.ActiveDocument.Selection;
        CodeClass2 cls = (CodeClass2)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementClass);

        // Set the header comment for the CodeClass.
        cls.Comment = "Comment added programmatically.";
    }
    catch (Exception e)
    {
        Console.WriteLine(e.Message);
    }
}

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.