Propriedade CodeClass2.DocComment
Obtém ou define o comentário do documento para a classe de código.
Namespace: EnvDTE80
Assembly: EnvDTE80 (em EnvDTE80.dll)
Sintaxe
'Declaração
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 propriedade
Tipo: String
Uma cadeia de caracteres que representa o comentário do documento.
Comentários
A propriedade de DocComment retorna o comentário ou atributo especial da documentação se houver um na classe do código. Se o idioma que implementa o modelo de código não tem um mecanismo de comentário da documentação, ou se não houver nenhum associados à classe de código, então DocComment retorna uma cadeia de caracteres vazia.
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 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);
}
}
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.
Consulte também
Referência
Outros recursos
Como compilar e executar os exemplos de código do modelo de objeto Automation