Comment class abstract final

A comment within the source code.

comment ::= endOfLineComment | blockComment | documentationComment

endOfLineComment ::= '//' (CHARACTER - EOL)* EOL

blockComment ::= '/ ' CHARACTER '*/'

documentationComment ::= '/ ' (CHARACTER | CommentReference) '*/' | ('///' (CHARACTER - EOL) EOL)+

Implemented types

Constructors

Comment()

Properties

beginToken Token
The first token included in this node's source range.
no setterinherited
childEntities Iterable<SyntacticEntity>
An iterator that can be used to iterate through all the entities (either AST nodes or tokens) that make up the contents of this node, including doc comments but excluding other comments.
no setterinherited
codeBlocks List<MdCodeBlock>
The markdown code blocks (both fenced and indented) contained in this comment.
no setter
docDirectives List<DocDirective>
no setter
docImports List<DocImport>
no setter
end int
The offset of the character immediately following the last character of this node's source range.
no setterinherited
endToken Token
The last token included in this node's source range.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
isBlock bool
Whether this is a block comment.
no setter
isDocumentation bool
Whether this is a documentation comment.
no setter
isEndOfLine bool
Whether this is an end-of-line comment.
no setter
isSynthetic bool
Whether this node is a synthetic node.
no setterinherited
length int
Return the number of characters in the syntactic entity's source range.
no setterinherited
offset int
Return the offset from the beginning of the file to the first character in the syntactic entity.
no setterinherited
parent AstNode?
Returns this node's parent node, or null if this node is the root of an AST structure.
no setterinherited
references NodeList<CommentReference>
The references embedded within the documentation comment.
no setter
root AstNode
The node at the root of this node's AST structure.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
tokens List<Token>
The tokens representing the comment.
no setter

Methods

accept<E>(AstVisitor<E> visitor) → E?
Use the given visitor to visit this node.
inherited
findPrevious(Token target) Token?
Returns the token before target, or null if it can't be found.
inherited
getProperty<E>(String name) → E?
Returns the value of the property with the given name, or null if this node doesn't have a property with the given name.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setProperty(String name, Object? value) → void
Set the value of the property with the given name to the given value.
inherited
thisOrAncestorMatching<E extends AstNode>(bool predicate(AstNode)) → E?
Returns either this node or the most immediate ancestor of this node for which the predicate returns true, or null if there's no such node.
inherited
thisOrAncestorOfType<E extends AstNode>() → E?
Returns either this node or the most immediate ancestor of this node that has the given type, or null if there's no such node.
inherited
toSource() String
Returns a textual description of this node in a form approximating valid source.
inherited
toString() String
A string representation of this object.
inherited
visitChildren(AstVisitor visitor) → void
Use the given visitor to visit all of the children of this node.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited