CodeCommentStatement Класс

Определение

Пространство имен:

System.CodeDom

Сборка:

System.CodeDom.dll

Пакет:

System.CodeDom v8.0.0

Исходный код:

CodeCommentStatement.cs

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

public ref class CodeCommentStatement : System::CodeDom::CodeStatement

public class CodeCommentStatement : System.CodeDom.CodeStatement

type CodeCommentStatement = class
    inherit CodeStatement

Public Class CodeCommentStatement
Inherits CodeStatement

Наследование

Object

CodeObject

CodeStatement

CodeCommentStatement

Примеры

В этом примере демонстрируется использование для CodeCommentStatement представления комментария в исходном коде.

// Create a CodeComment with some example comment text.

// The text of the comment.
// Whether the comment is a comment intended for documentation purposes.
CodeComment^ comment = gcnew CodeComment( "This comment was generated from a System.CodeDom.CodeComment",false );

// Create a CodeCommentStatement that contains the comment, in order
// to add the comment to a CodeTypeDeclaration Members collection.
CodeCommentStatement^ commentStatement = gcnew CodeCommentStatement( comment );

// A C# code generator produces the following source code for the preceeding example code:
// // This comment was generated from a System.CodeDom.CodeComment

// Create a CodeComment with some example comment text.
CodeComment comment = new CodeComment(
    // The text of the comment.
    "This comment was generated from a System.CodeDom.CodeComment",
    // Whether the comment is a comment intended for documentation purposes.
    false );

// Create a CodeCommentStatement that contains the comment, in order
// to add the comment to a CodeTypeDeclaration Members collection.
CodeCommentStatement commentStatement = new CodeCommentStatement( comment );

// A C# code generator produces the following source code for the preceeding example code:

// // This comment was generated from a System.CodeDom.CodeComment

     ' Create a CodeComment with some example comment text.
     Dim comment As New CodeComment( _
        "This comment was generated from a System.CodeDom.CodeComment", _
        False) ' Whether the comment is a documentation comment.
     
     ' Create a CodeCommentStatement that contains the comment, in order
     ' to add the comment to a CodeTypeDeclaration Members collection.
     Dim commentStatement As New CodeCommentStatement(comment)	

     ' A Visual Basic code generator produces the following source code for the preceeding example code:

     ' 'This comment was generated from a System.CodeDom.CodeComment

Комментарии

CodeCommentStatementможет использоваться для представления оператора с одним строковый комментарий. CodeCommentStatement — это оператор, поэтому его можно вставить в коллекцию инструкций и будет отображаться в отдельной строке. CodeCommentStatement можно также добавить в коллекцию CodeNamespace комментариев объекта или любого объекта, производного от CodeTypeMember.

Конструкторы

CodeCommentStatement()	Инициализирует новый экземпляр класса CodeCommentStatement.
CodeCommentStatement(CodeComment)	Инициализирует новый экземпляр класса CodeCommentStatement, используя указанный комментарий.
CodeCommentStatement(String)	Инициализирует новый экземпляр класса CodeCommentStatement, используя указанный текст в качестве содержимого.
CodeCommentStatement(String, Boolean)	Инициализирует новый экземпляр класса CodeCommentStatement, используя указанный текст и флаг комментария документации.

Свойства

Comment	Получает или задает содержимое комментария.
EndDirectives	Получает объект CodeDirectiveCollection, содержащий конечные директивы. (Унаследовано от CodeStatement)
LinePragma	Получает или задает строку, в которой содержится оператор кода. (Унаследовано от CodeStatement)
StartDirectives	Получает объект CodeDirectiveCollection, содержащий начальные директивы. (Унаследовано от CodeStatement)
UserData	Получает определяемые пользователем данные для текущего объекта. (Унаследовано от CodeObject)

Методы

Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

См. также раздел

• CodeComment