CodeNamespace.DocComment (Propiedad)

Artículo
08/10/2011

Obtiene o establece el comentario del documento correspondiente al elemento de modelo de código actual.

Espacio de nombres: EnvDTE
Ensamblado: EnvDTE (en EnvDTE.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 representa el comentario del documento.

Comentarios

DocComment devuelve el comentario de documentación especial o el atributo en caso de que exista en el 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 al elemento de código, DocComment devolverá una cadena vacía.

Nota

Esta propiedad es de sólo lectura para los elementos de código fuente de Visual Basic.

Además, 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 los elementos del 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.