CodeInterface.DocComment Свойство

Определение

Возвращает или задает комментарий к документу для текущего элемента модели кода.

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

Значение свойства

String

Строка, содержащая комментарий к документу.

Атрибуты

Комментарии

DocComment Возвращает Специальный комментарий или атрибут документации, если он есть в коде. Если язык, реализующий модель кода, не имеет механизма комментариев документации или если с элементом Code не связан ни один из них, то DocComment возвращает пустую строку.

Примечание

Это свойство доступно только для чтения для элементов кода из Visual Basic исходного кода.

Кроме того, значения элементов модели кода, такие как классы, структуры, функции, атрибуты, делегаты и т. д., могут быть недетерминированными после внесения определенных видов изменений. Это означает, что их значения не могут полагаться на то, что они всегда остаются неизменными. Дополнительные сведения см. в разделе значения элементов модели кода могут изменяться при обнаружении кода с помощью модели кода (Visual Basic).

Применяется к