Allow phpstan inline docblocks (and other doc tags)

@cmlara I'd recommend using normal @var blocks in Drupal code, I dont think theres a legitimate reason for our ecosystem to use @phpstan-var for inlines.

PHPStan/Psalm advanced types work in @var inlines perfectly fine, as far as I'm aware.

I think I've only used phpstan-var on class properties.

My opinion is it's not worth the exception, however if maintainer decides otherwise I'd suggest also adding the Psalm equivalent also.

Realistically the Drupal sniffs should not interfere with any other external systems that have a defined standard

We'll I think its reasonable for the Drupal standard to reject all /**/ comments, with a single whitelisted @var. It doesnt make sense to continuously add exceptions, unless for example we allow /** @anythingUntilEndOfLine */

Happy to continue to provide advice and anecdotes in dslack#phpstan.

I think your idea that we allow /** @anythingUntilEndOfLine */ for any doc comment tag is good. There is a trend in PHP to annotate types and variables inline in code, I think Coder can ignore that and let developers use any tag they want. I agree that @var is probably the best choice in most cases, but I'm not sure that we should enforce that as standard (at least not yet).

Pull requests welcome to relax this check for any doc tag!

Marking this as feature request.

I've created a merge request to relax the check based on the above.
In the MR I decided to allow doc comments that start with a doc tag (preceding whitespace is fine).

To illustrate, I've also added a couple of test cases:

function test3() {
  /** I am not allowed. */
  something();

  /**
    * I am also not allowed.
    * Even though I go on multiple lines.
    */
  something();

  /** @some-unknown-tag I am allowed. */
  something();

  /**
   *
   * @some-tag-on-the-third-line */
  something();

  /**
   * @some-tag-here
   *
   * Additonal text after is fine.
   */
  something();

  /**
   * There is some text here before the doc tag.
   *
   * This should not be allowed.
   *
   * @some-other-tag
   */
  something();
}

Thanks! Can you open a PR at https://github.com/pfrenssen/coder/pulls ? We are still doing the pull requests there for now.

Done: https://github.com/pfrenssen/coder/pull/269

Should I close the MR on GitLab?

Is there any estimate on how long it takes from a GitHub PR until the code appears in a release?

Thanks, merged!

Usually I try to make releases every 3 months if changes were merged in that period.

I think I can make a new release at Drupalcon on contribution day next Friday.

Coder 8.3.31 released with this fix!