InlineCommentSniff not correctly recognising type hints that should be allowed

[timhunt]

Both of these should be allowed (at least judging by the comment at https://github.com/moodlehq/moodle-cs/blob/main/moodle/Sniffs/Commenting/InlineCommentSniff.php#L191-L194) but I am currently getting them reported as errors in my code:

        /** @var assign $assign */
        [$assign] = $this->create_assignment(...);

        /** @var assign $assign */
        foreach ($assignments as $name => $assign) {

I think the first is explained by the switch from list(...) to [...]. The rule probably needs to be updated. Not sure why the second one is not working.

[andrewnicols]

Hi Tim,

This is nothing to do with lists or arrays. We don't curerntly allow inline docblock sniffs, only class member @vars. That is:

<?php

class Example {
    // This is allowed.
    /** @var assign The assignment */
    private assign $assign;

    public function doIt(): void {
        // This is not allowed per our coding style.
        /** @var assign $assign The assignment */
        $foo = $this->assign;
    }
}

[timhunt]

Your answer does not really seem to relate to my question.

The following type-hint is allowed

/** @var assign $foo The assignment */
$foo = get_assign();

but, for some reason, the slight extenions to this I meniton in the original report get flagged as problems, even though, as I say, there seem to be code in there to try to allow them.