CodeInterface.Comment Свойство

Определение

Получает или задает комментарий, связанный с объектом CodeInterface.Gets or sets the comment associated with the CodeInterface.

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(38)]
[get: System.Runtime.InteropServices.DispId(38)]
[get: System.Runtime.InteropServices.TypeLibFunc(1024)]
[set: System.Runtime.InteropServices.DispId(38)]
[set: System.Runtime.InteropServices.TypeLibFunc(1024)]
public string Comment { get; set; }
[<System.Runtime.InteropServices.DispId(38)>]
[<get: System.Runtime.InteropServices.DispId(38)>]
[<get: System.Runtime.InteropServices.TypeLibFunc(1024)>]
[<set: System.Runtime.InteropServices.DispId(38)>]
[<set: System.Runtime.InteropServices.TypeLibFunc(1024)>]
member this.Comment : string with get, set
Public Property Comment As String

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

String

Строка, представляющая комментарий, связанный с элементом кода.A string representing the comment associated with the code element.

Атрибуты

Комментарии

Comment Задает или возвращает комментарий заголовка.Comment sets or returns the header comment. Возвращаемый текст не содержит синтаксис комментария.When returned, the text does not contain comment syntax.

Текст комментария является производным от исходного документа, который содержит элемент Code.The comment text is derived from the source document that contains the code element. Количество собранных строк комментариев заголовков будет зависеть от языка, на котором записываются комментарии.The number of header comment lines collected will vary depending on the language in which the comments are written.

Если этот параметр задан, то Comment пытается сохранить стиль существующих комментариев с использованием синтаксиса, ориентированного на строки, и с разделителями, сохраняя все отступы до синтаксиса, связанного с строкой, путем определения, касается ли комментарий элемента кода или он отделяется пустой строкой и т. д.When set, Comment attempts to maintain the style of existing comments by using line-oriented versus delimited syntax, by maintaining any indentation prior to line-oriented syntax, by determining whether the comment touches the code element or is separated by a blank line, and so forth.

Примечание

Значения элементов модели кода, таких как классы, структуры, функции, атрибуты, делегаты и другие, после внесения некоторых изменений могут оказаться недетерминированными, другими словами, нельзя рассчитывать, что их значения будут всегда оставаться одинаковыми.The values of code model elements such as classes, structs, functions, attributes, delegates, and so forth can be non-deterministic after making certain kinds of edits, meaning that their values cannot be relied upon to always remain the same. Дополнительные сведения см. в разделе значения элементов модели кода могут изменяться при обнаружении кода с помощью модели кода (Visual Basic).For more information, see the section Code Model Element Values Can Change in Discovering Code by Using the Code Model (Visual Basic).

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