Compartir a través de


CodeClass2.DocComment (Propiedad)

Obtiene o establece el comentario de documento correspondiente a la clase de código.

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

Sintaxis

'Declaración
Property DocComment As String
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: String
Una cadena que representa el comentario del documento.

Comentarios

La propiedad DocComment devuelve el comentario de documentación especial o el atributo en caso de que exista en la clase de código. Si el lenguaje que implementa el modelo de código no tiene ningún mecanismo de comentario de documentación o si no hay ninguno asociado a la clase de código, DocComment devolverá una cadena vacía.

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 CodeClass2DocCommentExample(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 document comment for the CodeClass.
        cls.DocComment = "<doc>This is a DocComment\r\n</doc>";

    }
    catch (Exception e)
    {
        Console.WriteLine(e.Message);
    }
}

Seguridad de .NET Framework

Vea también

Referencia

CodeClass2 Interfaz

EnvDTE80 (Espacio de nombres)

Otros recursos

Cómo: Compilar y ejecutar los ejemplos de código del modelo de objetos de automatización

Detectar código utilizando el modelo de código (Visual Basic)

Detectar código utilizando el modelo de código (Visual C#)