vscode-php-docblocker icon indicating copy to clipboard operation
vscode-php-docblocker copied to clipboard

Support single line docs

Open oojacoboo opened this issue 7 years ago • 10 comments

Example:

/** @var \Foo $foo */
protected $foo

oojacoboo avatar May 20 '17 04:05 oojacoboo

How would you propose we differentiate the people that want this feature vs the people who don't?

neild3r avatar May 23 '17 13:05 neild3r

Why would you not want that? I don't understand why anyone would type that and not want phpdoc "intellisense".

oojacoboo avatar May 24 '17 02:05 oojacoboo

Do you mean you want the tag snippets to work after a /**?

neild3r avatar May 24 '17 07:05 neild3r

yes, that's correct.

oojacoboo avatar May 24 '17 14:05 oojacoboo

+1. Code intellisense extensions use this kind of docs to work. It would be so useful to have some sort of support for documenting vars.

artrz avatar Nov 24 '17 19:11 artrz

How would you propose we differentiate the people that want this feature vs the people who don't?

@neild3r, The way this works in the popular Sublime docblocker plugin is that if the user hits Enter after the /** they get the long-style doc block, but if they hit Spacebar or Shift+Enter they instead get the inline-style variable doc block.

See https://github.com/spadgos/sublime-jsdocs#variable-documentation

wunc avatar Mar 02 '18 17:03 wunc

@wunc this is also how it works with IntelliJ.

oojacoboo avatar Mar 02 '18 18:03 oojacoboo

Annoyingly because the way this extension triggers the docblock using snippets I can't really do it like this. I think it will probably be easiest to just have a config option to turn it on.

neild3r avatar Mar 24 '18 10:03 neild3r

Also I will try to take a look at implementing this in the next few days or so

neild3r avatar Mar 24 '18 10:03 neild3r

Sorry I never progressed this one. I've had an extremely busy year and not had much time to put into this plugin. I'm going to spend a little time over the Christmas break trying to add some features and will include this as one of them.

neild3r avatar Dec 24 '18 10:12 neild3r