Parameters can have comments

Author: dg

src/PhpGenerator/Parameter.php

@@ -23,6 +23,7 @@ class Parameter
 	use Nette\SmartObject;
 	use Traits\NameAware;
 	use Traits\AttributeAware;
+	use Traits\CommentAware;
 
 	private bool $reference = false;
 	private ?string $type = null;

src/PhpGenerator/Printer.php

@@ -331,7 +331,7 @@ protected function printParameters(Closure|GlobalFunction|Method $function, int
 		$special = false;
 		foreach ($function->getParameters() as $param) {
 			$param->validate();
-			$special = $special || $param instanceof PromotedParameter || $param->getAttributes();
+			$special = $special || $param instanceof PromotedParameter || $param->getAttributes() || $param->getComment();
 		}
 
 		if (!$special || ($this->singleParameterOnOneLine && count($function->getParameters()) === 1)) {
@@ -352,15 +352,13 @@ private function formatParameters(Closure|GlobalFunction|Method $function, bool
 
 		foreach ($params as $param) {
 			$variadic = $function->isVariadic() && $param === end($params);
-			$promoted = $param instanceof PromotedParameter ? $param : null;
 			$attrs = $this->printAttributes($param->getAttributes(), inline: true);
 			$res .=
-				($promoted ? $this->printDocComment($promoted) : '')
+				$this->printDocComment($param)
 				. ($attrs ? ($multiline ? substr($attrs, 0, -1) . "\n" : $attrs) : '')
-				. ($promoted ?
-					($promoted->getVisibility() ?: 'public')
-					. ($promoted->isReadOnly() && $param->getType() ? ' readonly' : '')
-					. ' ' : '')
+				. ($param instanceof PromotedParameter
+					? ($param->getVisibility() ?: 'public') . ($param->isReadOnly() && $param->getType() ? ' readonly' : '') . ' '
+					: '')
 				. ltrim($this->printType($param->getType(), $param->isNullable()) . ' ')
 				. ($param->isReference() ? '&' : '')
 				. ($variadic ? '...' : '')

src/PhpGenerator/PromotedParameter.php

@@ -18,7 +18,6 @@
 final class PromotedParameter extends Parameter
 {
 	use Traits\VisibilityAware;
-	use Traits\CommentAware;
 
 	private bool $readOnly = false;
 

tests/PhpGenerator/ClassType.attributes.phpt

@@ -34,6 +34,7 @@ $method = $class->addMethod('getHandle')
 	->addAttribute('ExampleAttribute');
 
 $method->addParameter('mode')
+	->addComment('comment')
 	->addAttribute('ExampleAttribute')
 	->addAttribute('WithArguments', [123]);
 

tests/PhpGenerator/ClassType.phpt

@@ -129,7 +129,8 @@ Assert::same($p, $method->getParameter('foo'));
 $method->removeParameter('foo');
 Assert::false($method->hasParameter('foo'));
 
-$method->addParameter('item');
+$method->addParameter('item')
+	->addComment('comment');
 
 $method->addParameter('res', null)
 		->setReference()

tests/PhpGenerator/expected/ClassType.attributes.expect

@@ -21,6 +21,7 @@ class Example
 	 */
 	#[ExampleAttribute]
 	public function getHandle(
+		/** comment */
 		#[ExampleAttribute, WithArguments(123)]
 		$mode,
 	) {

tests/PhpGenerator/expected/ClassType.expect

@@ -48,5 +48,10 @@ abstract class Example extends ParentClass implements IExample, IOne
 	}
 
 
-	abstract public function show($item, array|null &$res = null, stdClass|string|null $bar = null);
+	abstract public function show(
+		/** comment */
+		$item,
+		array|null &$res = null,
+		stdClass|string|null $bar = null,
+	);
 }

tests/PhpGenerator/expected/Extractor.classes.expect

@@ -60,8 +60,15 @@ class Class2 extends Class1 implements Interface2
 	 * Func3
 	 * @return Class1
 	 */
-	private function &func3(array $a, Class2 $b, Unknown $c, \Xyz\Unknown $d, ?callable $e, $f)
-	{
+	private function &func3(
+		/** foo */
+		array $a,
+		Class2 $b,
+		Unknown $c,
+		\Xyz\Unknown $d,
+		?callable $e,
+		$f,
+	) {
 	}
 
 

tests/PhpGenerator/fixtures/classes.php

@@ -67,7 +67,7 @@ class Class2 extends Class1 implements Interface2
 	 * Func3
 	 * @return Class1
 	 */
-	private function &func3(array $a, Class2 $b, \Abc\Unknown $c, \Xyz\Unknown $d, ?callable $e, $f)
+	private function &func3(/** foo */array $a, Class2 $b, \Abc\Unknown $c, \Xyz\Unknown $d, ?callable $e, $f)
 	{
 	}