Propriedade CodeClass2.Comment

Artigo
05/17/2015

Os conjuntos ou obtêm o comentário associado à classe de código.

Namespace: EnvDTE80
Assembly: EnvDTE80 (em EnvDTE80.dll)

Sintaxe

'Declaração
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 propriedade

Tipo: String
Uma cadeia de caracteres que representa o comentário.

Comentários

Comment define ou retorna o comentário do cabeçalho da classe. O texto retornado não contém a sintaxe de comentário. O texto é derivado de origem com base no estilo de comentário do idioma. Por exemplo, no C#, o delimitador de comentário é //, mas no Visual Basic, é apóstrofo (') ou Rem (curto para o comentário).

Quando definido como, Comment o tenta manter o estilo de qualquer comentário existente usando linha orientada na sintaxe limitada. No processo, o mantém todo o recuo de linha antes da sintaxe para determinar se o comentário toca o elemento de código ou estiver separado por uma linha em branco.

Dica

Os valores de código de modelagem elementos como classes, estruturas, funções, atributos, representantes, e assim por diante podem ser não determinísticas depois de fazer determinados tipos as edições do, o que significa que seus valores não podem ser confiáveis em para permanecer sempre os mesmos.Para obter mais informações, veja que os valores do elemento do modelo de código da seção podem ser alteradas em Descobrindo código usando o modelo de código (Visual Basic).

Exemplos

[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);
    }
}

Segurança do .NET Framework

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiável.