CodeProperty.Comment Свойство

Определение

Получает или задает комментарий, связанный с элементом кода.

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

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

String

Строка, представляющая комментарий, связанный с элементом кода.

Атрибуты

Комментарии

Comment Задает или возвращает комментарий заголовка. При возвращении текст не содержит синтаксис комментария.

Текст комментария является производным от исходного документа, который содержит элемент Code. Количество собранных строк комментариев заголовков будет зависеть от языка, на котором записываются комментарии.

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

Примечание

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

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