Поделиться через


XmlCommentSyntax Класс

Определение

public ref class XmlCommentSyntax sealed : Microsoft::CodeAnalysis::CSharp::Syntax::XmlNodeSyntax
public sealed class XmlCommentSyntax : Microsoft.CodeAnalysis.CSharp.Syntax.XmlNodeSyntax
type XmlCommentSyntax = class
    inherit XmlNodeSyntax
Public NotInheritable Class XmlCommentSyntax
Inherits XmlNodeSyntax
Наследование

Комментарии

Этот узел связан со следующими типами синтаксиса:

Свойства

ContainsAnnotations

Определяет, есть ли у этого узла или подузла, маркера или trivia заметки.

(Унаследовано от SyntaxNode)
ContainsDiagnostics

Определяет, есть ли на этом узле или у любого из его потомков узлов, маркеров или мелочей диагностика.

(Унаследовано от SyntaxNode)
ContainsDirectives

Определяет, есть ли у этого узла какие-либо директивы препроцессора-потомка.

(Унаследовано от SyntaxNode)
ContainsSkippedText

Определяет, есть ли в этом узле пропущенный текст-потомок.

(Унаследовано от SyntaxNode)
FullSpan

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

(Унаследовано от SyntaxNode)
HasLeadingTrivia

Определяет, есть ли у этого узла какие-либо ведущие мелочи.

(Унаследовано от SyntaxNode)
HasStructuredTrivia

Определяет, структурирована ли потомковая мелочь этого узла.

(Унаследовано от SyntaxNode)
HasTrailingTrivia

Определяет, есть ли у этого узла какие-либо конечные мелочи.

(Унаследовано от SyntaxNode)
IsMissing

Определяет, представляет ли узел языковую конструкцию, которая была фактически проанализирована из исходного кода. Отсутствующие узлы создаются анализатором в сценариях ошибок для представления конструкций, которые должны были присутствовать в исходном коде для успешной компиляции, но на самом деле отсутствовали.

(Унаследовано от SyntaxNode)
IsStructuredTrivia

Определяет, представляет ли этот узел структурированную мелочь.

(Унаследовано от SyntaxNode)
KindText (Унаследовано от SyntaxNode)
Language

Имя языка, синтаксиса для этого узла.

(Унаследовано от CSharpSyntaxNode)
LessThanExclamationMinusMinusToken
MinusMinusGreaterThanToken
Parent

Узел, содержащий этот узел в своей ChildNodes() коллекции.

(Унаследовано от SyntaxNode)
ParentTrivia (Унаследовано от SyntaxNode)
RawKind

Целое число, представляющее языковой тип данного узла.

(Унаследовано от SyntaxNode)
Span

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

(Унаследовано от SyntaxNode)
SpanStart

То же, что и при доступе к StartSpan.

(Унаследовано от SyntaxNode)
SyntaxTree

Возвращает SyntaxTree объект , владеющий узлом.

(Унаследовано от SyntaxNode)
SyntaxTreeCore (Унаследовано от CSharpSyntaxNode)
TextTokens

Методы

Accept(CSharpSyntaxVisitor)
Accept<TResult>(CSharpSyntaxVisitor<TResult>)
AddTextTokens(SyntaxToken[])
Ancestors(Boolean)

Возвращает список узлов-предков.

(Унаследовано от SyntaxNode)
AncestorsAndSelf(Boolean)

Возвращает список узлов-предков (включая этот узел)

(Унаследовано от SyntaxNode)
ChildNodes()

Возвращает список дочерних узлов в порядке префикса документа.

(Унаследовано от SyntaxNode)
ChildNodesAndTokens()

Список дочерних узлов и токенов этого узла, где каждый элемент является экземпляром SyntaxNodeOrToken.

(Унаследовано от SyntaxNode)
ChildThatContainsPosition(Int32) (Унаследовано от SyntaxNode)
ChildTokens()

Возвращает список прямых дочерних маркеров этого узла.

(Унаследовано от SyntaxNode)
Contains(SyntaxNode)

Определяет, является ли указанный узел потомком этого узла. Возвращает значение true для текущего узла.

(Унаследовано от SyntaxNode)
ContainsDirective(Int32)

Возвращает значение true, если этот узел содержит директивы (например #if, , #nullableи т. д.) с соответствующим типом.

(Унаследовано от SyntaxNode)
CopyAnnotationsTo<T>(T)

Копирует все объекты SyntaxAnnotation , если таковые есть, из этого экземпляра SyntaxNode и присоединяет их к новому экземпляру на nodeоснове .

(Унаследовано от SyntaxNode)
DescendantNodes(Func<SyntaxNode,Boolean>, Boolean)

Возвращает список узлов-потомков в порядке префикса документа.

(Унаследовано от SyntaxNode)
DescendantNodes(TextSpan, Func<SyntaxNode,Boolean>, Boolean)

Возвращает список узлов-потомков в порядке префикса документа.

(Унаследовано от SyntaxNode)
DescendantNodesAndSelf(Func<SyntaxNode,Boolean>, Boolean)

Возвращает список узлов-потомков (включая этот узел) в порядке префикса документа.

(Унаследовано от SyntaxNode)
DescendantNodesAndSelf(TextSpan, Func<SyntaxNode,Boolean>, Boolean)

Возвращает список узлов-потомков (включая этот узел) в порядке префикса документа.

(Унаследовано от SyntaxNode)
DescendantNodesAndTokens(Func<SyntaxNode,Boolean>, Boolean)

Возвращает список узлов-потомков и маркеров в порядке префикса документа.

(Унаследовано от SyntaxNode)
DescendantNodesAndTokens(TextSpan, Func<SyntaxNode,Boolean>, Boolean)

Возвращает список узлов-потомков и токенов в порядке префикса документа.

(Унаследовано от SyntaxNode)
DescendantNodesAndTokensAndSelf(Func<SyntaxNode,Boolean>, Boolean)

Возвращает список узлов-потомков и токенов (включая этот узел) в порядке префикса документа.

(Унаследовано от SyntaxNode)
DescendantNodesAndTokensAndSelf(TextSpan, Func<SyntaxNode,Boolean>, Boolean)

Возвращает список узлов-потомков и токенов (включая этот узел) в порядке префикса документа.

(Унаследовано от SyntaxNode)
DescendantTokens(Func<SyntaxNode,Boolean>, Boolean)

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

(Унаследовано от SyntaxNode)
DescendantTokens(TextSpan, Func<SyntaxNode,Boolean>, Boolean)

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

(Унаследовано от SyntaxNode)
DescendantTrivia(Func<SyntaxNode,Boolean>, Boolean)

Получите список всех мелочей, связанных с узлами-потомками и токенами.

(Унаследовано от SyntaxNode)
DescendantTrivia(TextSpan, Func<SyntaxNode,Boolean>, Boolean)

Получите список всех мелочей, связанных с узлами-потомками и токенами.

(Унаследовано от SyntaxNode)
EquivalentToCore(SyntaxNode)

Определите, является ли этот узел структурно эквивалентным другому.

(Унаследовано от CSharpSyntaxNode)
FindNode(TextSpan, Boolean, Boolean)

Находит узел с наименьшим FullSpan значением , содержащим span. getInnermostNodeForTie используется для определения поведения в случае привязки (т. е. узла, имеющего тот же диапазон, что и его родительский элемент). Если getInnermostNodeForTie имеет значение true, то возвращается наименьший убывающей узел, охватывающий заданный span. В противном случае он возвращает внешний узел, охватывающий заданный span.

(Унаследовано от SyntaxNode)
FindToken(Int32, Boolean)

Находит маркер в соответствии со следующими правилами:

  1. Если позиция соответствует значению End of the node/s FullSpan and the node is CompilationUnit, возвращается значение EoF.

  2. Если узел. FullSpan.Contains(position) затем возвращается токен, содержащий указанную позицию.

  3. В противном случае создается исключение ArgumentOutOfRangeException

(Унаследовано от CSharpSyntaxNode)
FindTokenCore(Int32, Boolean)

Находит токен-потомок этого узла, диапазон которого включает указанную позицию.

(Унаследовано от SyntaxNode)
FindTokenCore(Int32, Func<SyntaxTrivia,Boolean>)

Находит токен-потомок этого узла, диапазон которого включает указанную позицию.

(Унаследовано от SyntaxNode)
FindTrivia(Int32, Boolean)

Находит дочерний элемент этого узла, диапазон которого включает указанную позицию.

(Унаследовано от CSharpSyntaxNode)
FindTrivia(Int32, Func<SyntaxTrivia,Boolean>)

Находит дочерний элемент этого узла в указанной позиции, где позиция находится в пределах диапазона узла.

(Унаследовано от CSharpSyntaxNode)
FindTriviaCore(Int32, Boolean)

Находит дочерний элемент этого узла, диапазон которого включает указанную позицию.

(Унаследовано от SyntaxNode)
FirstAncestorOrSelf<TNode,TArg>(Func<TNode,TArg,Boolean>, TArg, Boolean)

Возвращает первый узел типа TNode, соответствующий предикату.

(Унаследовано от SyntaxNode)
FirstAncestorOrSelf<TNode>(Func<TNode,Boolean>, Boolean)

Возвращает первый узел типа TNode, соответствующий предикату.

(Унаследовано от SyntaxNode)
GetAnnotatedNodes(String)

Возвращает все узлы с указанным типом заметки.

(Унаследовано от SyntaxNode)
GetAnnotatedNodes(SyntaxAnnotation)

Возвращает все узлы с указанной заметкой.

(Унаследовано от SyntaxNode)
GetAnnotatedNodesAndTokens(String)

Возвращает все узлы и маркеры с заметкой указанного типа заметки.

(Унаследовано от SyntaxNode)
GetAnnotatedNodesAndTokens(String[])

Возвращает все узлы и маркеры с заметками указанных типов заметок.

(Унаследовано от SyntaxNode)
GetAnnotatedNodesAndTokens(SyntaxAnnotation)

Возвращает все узлы и маркеры с указанной заметкой.

(Унаследовано от SyntaxNode)
GetAnnotatedTokens(String)

Возвращает все маркеры с указанным типом заметки.

(Унаследовано от SyntaxNode)
GetAnnotatedTokens(SyntaxAnnotation)

Возвращает все маркеры с указанной заметкой.

(Унаследовано от SyntaxNode)
GetAnnotatedTrivia(String)

Возвращает все элементы с заметкой указанного типа заметки.

(Унаследовано от SyntaxNode)
GetAnnotatedTrivia(String[])

Возвращает все мелочи с заметкой указанных типов заметок.

(Унаследовано от SyntaxNode)
GetAnnotatedTrivia(SyntaxAnnotation)

Возвращает все мелочи с указанной заметкой.

(Унаследовано от SyntaxNode)
GetAnnotations(IEnumerable<String>)

Возвращает все заметки с указанными типами заметок.

(Унаследовано от SyntaxNode)
GetAnnotations(String)

Возвращает все заметки с указанным типом заметки.

(Унаследовано от SyntaxNode)
GetDiagnostics()

Возвращает список всех диагностика в дочернем дереве, в корне которого указан этот узел. Этот метод не фильтрует диагностика на основе #pragmas и параметров компилятора, таких как nowarn, warnaserror и т. д.

(Унаследовано от CSharpSyntaxNode)
GetFirstDirective(Func<DirectiveTriviaSyntax,Boolean>)

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

(Унаследовано от CSharpSyntaxNode)
GetFirstToken(Boolean, Boolean, Boolean, Boolean)

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

(Унаследовано от CSharpSyntaxNode)
GetLastDirective(Func<DirectiveTriviaSyntax,Boolean>)

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

(Унаследовано от CSharpSyntaxNode)
GetLastToken(Boolean, Boolean, Boolean, Boolean)

Возвращает последний маркер ненулевой ширины дерева, укорененные этим узлом.

(Унаследовано от CSharpSyntaxNode)
GetLeadingTrivia()

Список мелочей, который отображается перед этим узлом в исходном коде.

(Унаследовано от CSharpSyntaxNode)
GetLocation()

Location Возвращает для этого узла.

(Унаследовано от CSharpSyntaxNode)
GetRed<T>(T, Int32) (Унаследовано от SyntaxNode)
GetRedAtZero<T>(T) (Унаследовано от SyntaxNode)
GetReference()

SyntaxReference Возвращает для этого синтаксического узла. CommonSyntaxReferences можно использовать для восстановления доступа к узлу синтаксиса без сохранения всего дерева и исходного текста в памяти.

(Унаследовано от SyntaxNode)
GetText(Encoding, SourceHashAlgorithm)

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

(Унаследовано от SyntaxNode)
GetTrailingTrivia()

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

(Унаследовано от CSharpSyntaxNode)
HasAnnotation(SyntaxAnnotation)

Определяет, содержит ли этот узел определенную заметку.

(Унаследовано от SyntaxNode)
HasAnnotations(IEnumerable<String>)

Определяет, содержит ли этот узел какие-либо заметки с определенными типами заметок.

(Унаследовано от SyntaxNode)
HasAnnotations(String)

Определяет, содержит ли этот узел заметки с определенным типом заметок.

(Унаследовано от SyntaxNode)
InsertNodesInListCore(SyntaxNode, IEnumerable<SyntaxNode>, Boolean) (Унаследовано от CSharpSyntaxNode)
InsertTokensInListCore(SyntaxToken, IEnumerable<SyntaxToken>, Boolean) (Унаследовано от CSharpSyntaxNode)
InsertTriviaInListCore(SyntaxTrivia, IEnumerable<SyntaxTrivia>, Boolean) (Унаследовано от CSharpSyntaxNode)
IsEquivalentTo(SyntaxNode)

Определите, является ли этот узел структурно эквивалентным другому.

(Унаследовано от SyntaxNode)
IsEquivalentTo(SyntaxNode, Boolean)

Определяет, совпадают ли два узла, игнорируя различия в пустяках.

(Унаследовано от SyntaxNode)
IsEquivalentToCore(SyntaxNode, Boolean) (Унаследовано от CSharpSyntaxNode)
IsIncrementallyIdenticalTo(SyntaxNode)

Возвращает значение true, если эти два узла считаются "инкрементно идентичными". Инкрементно идентичный SyntaxTree узел возникает, когда выполняется добавочный анализ с помощью WithChangedText(SourceText) инкрементного синтаксического анализа может взять узел из исходного дерева и полностью использовать его в новом дереве. В этом случае ToFullString() каждый узел будет одинаковым, хотя они могут иметь разные родительские элементы и могут находиться в разных положениях в соответствующих деревьях. Если два узла инкрементно идентичны, все дочерние элементы каждого узла также будут постепенно идентичны.

(Унаследовано от SyntaxNode)
IsPartOfStructuredTrivia()

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

(Унаследовано от SyntaxNode)
Kind()

SyntaxKind Возвращает значение узла .

(Унаследовано от CSharpSyntaxNode)
NormalizeWhitespaceCore(String, String, Boolean) (Унаследовано от CSharpSyntaxNode)
RemoveNodesCore(IEnumerable<SyntaxNode>, SyntaxRemoveOptions) (Унаследовано от CSharpSyntaxNode)
ReplaceCore<TNode>(IEnumerable<TNode>, Func<TNode,TNode,SyntaxNode>, IEnumerable<SyntaxToken>, Func<SyntaxToken,SyntaxToken,SyntaxToken>, IEnumerable<SyntaxTrivia>, Func<SyntaxTrivia,SyntaxTrivia,SyntaxTrivia>) (Унаследовано от CSharpSyntaxNode)
ReplaceNodeInListCore(SyntaxNode, IEnumerable<SyntaxNode>) (Унаследовано от CSharpSyntaxNode)
ReplaceTokenInListCore(SyntaxToken, IEnumerable<SyntaxToken>) (Унаследовано от CSharpSyntaxNode)
ReplaceTriviaInListCore(SyntaxTrivia, IEnumerable<SyntaxTrivia>) (Унаследовано от CSharpSyntaxNode)
SerializeTo(Stream, CancellationToken)
Устаревшие..
Устаревшие..

Сериализует узел в заданный streamобъект . Оставляет stream открытым для дальнейших операций записи.

(Унаследовано от SyntaxNode)
ToFullString()

Возвращает полное строковое представление этого узла, включая его начальные и конечные мелочи.

(Унаследовано от SyntaxNode)
ToString()

Возвращает строковое представление этого узла, не включая его начальные и конечные значения.

(Унаследовано от SyntaxNode)
Update(SyntaxToken, SyntaxTokenList, SyntaxToken)
WithLessThanExclamationMinusMinusToken(SyntaxToken)
WithMinusMinusGreaterThanToken(SyntaxToken)
WithTextTokens(SyntaxTokenList)
WriteTo(TextWriter)

Записывает полный текст этого узла в указанный TextWriter.

(Унаследовано от SyntaxNode)

Явные реализации интерфейса

IFormattable.ToString(String, IFormatProvider) (Унаследовано от CSharpSyntaxNode)

Методы расширения

GetFirstDirective(SyntaxNode, Func<DirectiveTriviaSyntax,Boolean>)

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

GetLastDirective(SyntaxNode, Func<DirectiveTriviaSyntax,Boolean>)

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

Kind(SyntaxNode)

Возвращает SyntaxKind для SyntaxNode свойства from RawKind .

TryGetInferredMemberName(SyntaxNode)

При указании выражения инициализатора выводится имя анонимного свойства или элемента кортежа. Возвращает значение NULL, если не удалось

ContainsDirective(SyntaxNode, SyntaxKind)

Возвращает значение true, если этот узел содержит директивы (например #if, , #nullableи т. д.) с соответствующим типом.

IsKind(SyntaxNode, SyntaxKind)

Определяет, имеет ли SyntaxNode указанный тип.

GetCurrentNode<TNode>(SyntaxNode, TNode)

Возвращает узел в поддереве, соответствующий исходному отслеживаемого узла. Используйте TrackNodes, чтобы начать отслеживание узлов.

GetCurrentNodes<TNode>(SyntaxNode, TNode)

Возвращает узлы в поддереве, соответствующие исходному отслеживаемого узла. Используйте TrackNodes, чтобы начать отслеживание узлов.

GetCurrentNodes<TNode>(SyntaxNode, IEnumerable<TNode>)

Возвращает узлы в поддереве, соответствующие исходным отслеживаемых узлам. Используйте TrackNodes, чтобы начать отслеживание узлов.

TryGetInferredMemberName(SyntaxNode)

Выражение инициализатора выводит имя анонимного свойства или элемента кортежа. Возвращает значение Nothing в случае неудачи

GetDirectives(SyntaxNode, Func<DirectiveTriviaSyntax,Boolean>)

Возвращает элементы DirectiveTriviaSyntax для указанного SyntaxNode с необязательной фильтрацией.

GetFirstDirective(SyntaxNode, Func<DirectiveTriviaSyntax,Boolean>)

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

GetLastDirective(SyntaxNode, Func<DirectiveTriviaSyntax,Boolean>)

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

Kind(SyntaxNode)

Возвращает SyntaxKind значение для SyntaxNode свойства from RawKind .

ContainsDirective(SyntaxNode, SyntaxKind)

Возвращает значение true, если этот узел содержит директивы (например #if, , #nullableи т. д.) с соответствующим типом.

IsKind(SyntaxNode, SyntaxKind)

Определяет, имеет ли SyntaxNode тип указанного типа.

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