[PHPDoc] Issue with /** */ : bad type and syntax error

Jean-FrancoisHIVERT

Hi,

Another 2 issues about PHP documentation /** */

Settings:

"editor.formatOnType": false,
"editor.formatOnSave": false,
"editor.formatOnPaste": false,
"php.format.codeStyle": "Off",

Test:

Create a class property of type object and declare this type before to create the documentation /** */

Issue 1:

/**
 * @var PhpCliShell\Application\Firewall\Program\FirewallInterface
 */
protected FirewallInterface $_program;

Just missing the \ at the begining to have a FQDN type

Issue 2:

Happen when we tape /** + ENTER quickly.

Thank you.

Jean-FrancoisHIVERT

@JakubMisek Hi, is it possible to review this issue please?
I have 2 other issues, I will create another tickets soon.

Thank you.

JakubMisek

Jean-FrancoisHIVERT thank you for reminding us. This issue is not happening on our tests tho; isn't possible there are two conflicting VSCode extensions for PHP Doc Block installed on the machine?

Jean-FrancoisHIVERT

Just testing again and got:

   /**
     * Summary of Devsense\Helper\fctTest
     * @param AbstractHelper $helper
     * @return void
     */
     * 
     */
    function fctTest(AbstractHelper $helper) {
    }

These are my addons in my Visual Studio Code:

JakubMisek

Jean-FrancoisHIVERT it's weird

the code is incorrectly indented (not as we do it)
the additional */ is not inserted by our extension
and we don't even handle the [enter] key actually.

Based on this I would guess there is either another extension that puts it there (which isn't)
or a custom code snippet for /**?

If you have a custom code snippet for /**, it's not working well with us - we would have to fix it.

MiloslavBeno

Probably not related, but I can see Test Adapter Converter and Test Explorer UI, what PHP Tools version is installed on the machine? These are old prerequisites that are no longer necessary.

I've tried to create a test case, but it never happened. Maybe it's related to SSH extension. Does it happen to you when you run PHP Tools locally on VSCode?

Thanks

Jean-FrancoisHIVERT

Ok thank you, give me few days to check on my side.

Jean-FrancoisHIVERT

Just tested and:

I have not any custom snippets
On another computer, Visual Studio Code autocomplete /**
I have this bug since PHP Tools autocomplete function/method doc
I tested to disable some settings about PHP/suggestions but /** is always follow by */

Of course on the new computer, I never installed PHP Tools or another PHP extension but only Docker extension.
Another point, on this new computer Visual Studio Sync is not enabled.

Jean-FrancoisHIVERT

About this PHP doc autocompletion, why with `` disabled, it continues to work?
https://docs.devsense.com/en/vscode/editor/phpdoc

{
    "editor.formatOnType": false,
    "editor.formatOnSave": false,
    "editor.formatOnPaste": false,
    "php.format.codeStyle": "Off",
    "php.format.rules.openBraceOnNewLineForFunctions": true,
    "php.format.rules.openBraceOnNewLineForLambdas": true,
    "php.format.rules.openBraceOnNewLineForAnonymousClasses": true,
    "php.format.rules.openBraceOnNewLineForTypes": true,
    "php.format.rules.indentBraces": false,
    "php.format.rules.elseOnNewLine": false,
    "php.format.rules.spaceAfterCast": true,
    "php.format.rules.arrayInitializersAlignKeyValuePairs": false,
    "php.completion.parameters": "none",
    "php.completion.autoimport": "none",
    ...
    "php.version": "8.1.11",
    "php.suggest.basic": false,
    "php.validate.enable": false
}

Whit this configuration, PHP Tools autocomplete function/method PHP doc after /**

Jean-FrancoisHIVERT

Sorry in my previous message, I wanted to say:
About this PHP doc autocompletion, why with editor.formatOnType disabled, it continues to work?

A short video about the issue, it does not always happen:

JakubMisek

Jean-FrancoisHIVERT alright;

we have managed to get the bug as well! It happens when it's too slow to complete the block immediately

we'll try to fix it

JakubMisek

Jean-FrancoisHIVERT fixed!

https://github.com/DEVSENSE/phptools-docs/issues/243#issuecomment-1397511044

Thank you @Jean-FrancoisHIVERT

Jean-FrancoisHIVERT

I will test as soon as possible on another computer with a fresh VSC installation, disable PHP options, install PHP Tools with default configuration and see if I get this issue or not. (User settings sync disabled of course)

JakubMisek

the latest pre-release (1.27.12161) fixes the bug with /** completion

I'm going to close this thread. If there would be anything else, please let us know in a new one :)