You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
One of my most-used Sublime plugins was DoxyDoxygen, and a great feature of that was alt+Q to update a method's docblock.
There are a few aspects to this feature:
alt+Q would add a docblock to a method if one wasn't there before, allowing the user to tab through all of the placeholder fields (see Figure 1).
If some of the placeholders are filled in, but others still exist, alt+Q will allow the user to tab through remaining placeholders again (see Figure 2).
if the method signature or return type have changed, alt+Q will amend the docblock, retaining any portions that haven't changed (see Figure 3).
Docblock formatting is fixed on-demand (see Figure 4).
I haven't looked to see how they accomplish these things in the DoxyDoxygen plugin, but we can definitely work to bring some of that functionality to vscode.
Examples
All examples below are triggered using alt+Q
Figure 1
Adding docblock to method
Figure 2
Updating existing docblock placeholders
Figure 3
Updating existing docblock with a changed method signature
Figure 4
Fixing any issues with docblock formatting, including wrapping and intending long descriptions
The text was updated successfully, but these errors were encountered:
I'm certainly keen on getting some of this in. It's something I've been meaning to do for a while. I think the first one is just to add any missing param and return data and then leave everything else.
One of my most-used Sublime plugins was DoxyDoxygen, and a great feature of that was
alt+Q
to update a method's docblock.There are a few aspects to this feature:
alt+Q
would add a docblock to a method if one wasn't there before, allowing the user to tab through all of the placeholder fields (see Figure 1).alt+Q
will allow the user to tab through remaining placeholders again (see Figure 2).alt+Q
will amend the docblock, retaining any portions that haven't changed (see Figure 3).I haven't looked to see how they accomplish these things in the DoxyDoxygen plugin, but we can definitely work to bring some of that functionality to vscode.
Examples
All examples below are triggered using
alt+Q
Figure 1
Adding docblock to method
Figure 2
Updating existing docblock placeholders
Figure 3
Updating existing docblock with a changed method signature
Figure 4
Fixing any issues with docblock formatting, including wrapping and intending long descriptions
The text was updated successfully, but these errors were encountered: