Rework comments support for pretty-printing

phpstan-baseline.neon

@@ -29,3 +29,9 @@ parameters:
 			identifier: property.dynamicName
 			count: 2
 			path: src/Printer/Printer.php
+
+		-
+			message: '#^Variable property access on PHPStan\\PhpDocParser\\Ast\\Node\.$#'
+			identifier: property.dynamicName
+			count: 1
+			path: tests/PHPStan/Parser/TypeParserTest.php

src/Ast/Comment.php

@@ -4,25 +4,26 @@
 
 use function trim;
 
-class Comment
+class Comment implements Node
 {
 
-	public string $text;
-
-	public int $startLine;
+	use NodeAttributes;
 
-	public int $startIndex;
+	public string $text;
 
-	public function __construct(string $text, int $startLine = -1, int $startIndex = -1)
+	public function __construct(string $text)
 	{
 		$this->text = $text;
-		$this->startLine = $startLine;
-		$this->startIndex = $startIndex;
 	}
 
 	public function getReformattedText(): string
 	{
 		return trim($this->text);
 	}
 
+	public function __toString(): string
+	{
+		return $this->getReformattedText();
+	}
+
 }

src/Parser/TokenIterator.php

@@ -3,6 +3,7 @@
 namespace PHPStan\PhpDocParser\Parser;
 
 use LogicException;
+use PHPStan\PhpDocParser\Ast\Attribute;
 use PHPStan\PhpDocParser\Ast\Comment;
 use PHPStan\PhpDocParser\Lexer\Lexer;
 use function array_pop;
@@ -232,8 +233,18 @@ public function skipNewLineTokens(): void
 	public function skipNewLineTokensAndConsumeComments(): void
 	{
 		if ($this->currentTokenType() === Lexer::TOKEN_COMMENT) {
-			$this->comments[] = new Comment($this->currentTokenValue(), $this->currentTokenLine(), $this->currentTokenIndex());
+			$startLine = $this->currentTokenLine();
+			$startIndex = $this->currentTokenIndex();
+			$text = $this->currentTokenValue();
+
 			$this->next();
+
+			$c = new Comment($text);
+			$c->setAttribute(Attribute::START_LINE, $startLine);
+			$c->setAttribute(Attribute::START_INDEX, $startIndex);
+			$c->setAttribute(Attribute::END_LINE, $this->currentTokenLine());
+			$c->setAttribute(Attribute::END_INDEX, $this->currentTokenIndex());
+			$this->comments[] = $c;
 		}
 
 		if (!$this->isCurrentTokenType(Lexer::TOKEN_PHPDOC_EOL)) {
@@ -246,8 +257,18 @@ public function skipNewLineTokensAndConsumeComments(): void
 				continue;
 			}
 
-			$this->comments[] = new Comment($this->currentTokenValue(), $this->currentTokenLine(), $this->currentTokenIndex());
+			$startLine = $this->currentTokenLine();
+			$startIndex = $this->currentTokenIndex();
+			$text = $this->currentTokenValue();
+
 			$this->next();
+
+			$c = new Comment($text);
+			$c->setAttribute(Attribute::START_LINE, $startLine);
+			$c->setAttribute(Attribute::START_INDEX, $startIndex);
+			$c->setAttribute(Attribute::END_LINE, $this->currentTokenLine());
+			$c->setAttribute(Attribute::END_INDEX, $this->currentTokenIndex());
+			$this->comments[] = $c;
 		} while ($foundNewLine === true);
 	}