CodeEvent.DocComment (Propiedad)

Artículo
08/10/2011

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

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

Sintaxis

'Declaración
Property DocComment As String
    Get
    Set

string DocComment { get; set; }

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

abstract DocComment : string with get, set

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

Valor de propiedad

Tipo: System.String
Cadena que contiene un comentario de documentación asociado al elemento de evento de código o una cadena vacía si no se proporciona ningún comentario.

Comentarios

Se devuelve una cadena vacía si no se proporciona ningún comentario o si el lenguaje que implementa el código no tiene un mecanismo de comentarios de documentación.

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

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 DocComment(EnvDTE80.DTE2 dte)
{
    TextSelection objTextSel;
    EnvDTE80.CodeEvent codeEvent;
    objTextSel = (TextSelection)dte.ActiveDocument.Selection;
    codeEvent = (EnvDTE80.CodeEvent)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementEvent);

    MessageBox.Show("\nDocComment property: " +
                    codeEvent.DocComment, "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.