CodeInterface.DocComment Propriedade

Definição

Obtém ou define o comentário do documento para o elemento do modelo de código atual.

public:
 property System::String ^ DocComment { System::String ^ get(); void set(System::String ^ value); };
public:
 property Platform::String ^ DocComment { Platform::String ^ get(); void set(Platform::String ^ value); };
[System.Runtime.InteropServices.DispId(37)]
public string DocComment { [System.Runtime.InteropServices.DispId(37)] [System.Runtime.InteropServices.TypeLibFunc(1024)] get; [System.Runtime.InteropServices.DispId(37)] [System.Runtime.InteropServices.TypeLibFunc(1024)] set; }
[<System.Runtime.InteropServices.DispId(37)>]
[<get: System.Runtime.InteropServices.DispId(37)>]
[<get: System.Runtime.InteropServices.TypeLibFunc(1024)>]
[<set: System.Runtime.InteropServices.DispId(37)>]
[<set: System.Runtime.InteropServices.TypeLibFunc(1024)>]
member this.DocComment : string with get, set
Public Property DocComment As String

Valor da propriedade

String

Uma cadeia de caracteres que representa o comentário do documento.

Atributos

Comentários

DocComment Retorna o atributo ou comentário de documentação especial se houver um no código. Se a linguagem que implementa o modelo de código não tiver um mecanismo de comentário de documentação ou se não houver nenhum associado ao elemento de código, DocComment o retornará uma cadeia de caracteres vazia.

Observação

Esta propriedade é somente leitura para elementos de código de Visual Basic código-fonte.

Além disso, os valores de elementos de modelo de código como classes, structs, funções, atributos, delegados e assim por diante podem ser não determinísticos depois de fazer certos tipos de edição, o que significa que seus valores não podem ser dependentes para sempre permanecem os mesmos. Para obter mais informações, consulte os valores de elemento de modelo de código de seção podem ser alterados na descoberta de código usando o modelo de código (Visual Basic).

Aplica-se a