Class Comment

  • All Implemented Interfaces:
    Comparable<AstNode>, Iterable<Node>

    public class Comment
    extends AstNode
    Node representing comments. Node type is Token.COMMENT.

    JavaScript effectively has five comment types:

    1. // line comments
    2. /* block comments *\/
    3. /** jsdoc comments *\/
    4. <!-- html-open line comments
    5. ^\\s*--> html-close line comments

    The first three should be familiar to Java programmers. JsDoc comments are really just block comments with some conventions about the formatting within the comment delimiters. Line and block comments are described in the Ecma-262 specification.

    SpiderMonkey and Rhino also support HTML comment syntax, but somewhat counterintuitively, the syntax does not produce a block comment. Instead, everything from the string <!-- through the end of the line is considered a comment, and if the token --> is the first non-whitespace on the line, then the line is considered a line comment. This is to support parsing JavaScript in <script> HTML tags that has been "hidden" from very old browsers by surrounding it with HTML comment delimiters.

    Note the node start position for Comment nodes is still relative to the parent, but Comments are always stored directly in the AstRoot node, so they are also effectively absolute offsets.

    • Constructor Detail

      • Comment

        public Comment​(int pos,
                       int len,
                       Token.CommentType type,
                       String value)
        Constructs a new Comment
        pos - the start position
        len - the length including delimiter(s)
        type - the comment type
        value - the value of the comment, as a string
    • Method Detail

      • getCommentType

        public Token.CommentType getCommentType()
        Returns the comment style
      • getValue

        public String getValue()
        Returns a string of the comment value.
      • toSource

        public String toSource​(int depth)
        Description copied from class: AstNode
        Emits source code for this node. Callee is responsible for calling this function recursively on children, incrementing indent as appropriate.

        Note: if the parser was in error-recovery mode, some AST nodes may have null children that are expected to be non-null when no errors are present. In this situation, the behavior of the toSource method is undefined: toSource implementations may assume that the AST node is error-free, since it is intended to be invoked only at runtime after a successful parse.

        Specified by:
        toSource in class AstNode
        depth - the current recursion depth, typically beginning at 0 when called on the root node.