Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

JSDoc doesn't support methods that are inside of a context #70162

Closed
ghost opened this issue Mar 10, 2019 · 2 comments
Closed

JSDoc doesn't support methods that are inside of a context #70162

ghost opened this issue Mar 10, 2019 · 2 comments
Assignees
@mjbvz
Labels
upstream Issue identified as 'upstream' component related (exists outside of VS Code)

Comments

@ghost
Copy link

ghost commented Mar 10, 2019 •
edited by ghost

Issue Type: Bug

  1. Initialize an object
  2. Give the object a method with at least one parameter
  3. Type "/**" above the method and press enter

Actual:
The comment block is not pre-filled with our parameter

Animated GIF
(vscode)

Expected:
The comment block should be pre-filled with our parameter

Animated GIF
(sublime)

VS Code version: Code 1.32.1 (05f146c, 2019-03-08T00:51:49.278Z)
OS version:

Extensions (4)
Extension Author (truncated) Version
jsrefactor cms 2.15.1
vscode-gist ken 3.0.3
vetur oct 0.16.2
nunjucks ron 0.2.3
@ghost ghost changed the title JSDoc doesn't support functions in objects JSDoc doesn't support context functions Mar 10, 2019
@ghost ghost changed the title JSDoc doesn't support context functions JSDoc doesn't support context methods Mar 10, 2019
@ghost ghost changed the title JSDoc doesn't support context methods JSDoc doesn't support methods that are inside a context Mar 10, 2019
@ghost ghost changed the title JSDoc doesn't support methods that are inside a context JSDoc doesn't support methods that are inside of a context Mar 10, 2019
@mjbvz
Copy link
Contributor

mjbvz commented Mar 11, 2019

If you are adding a comment before obj, I don't think it is expected that params for myMethod should be added; the jsdoc should be on the direct element you are trying to comment

microsoft/TypeScript#27638 tracks why commenting before obj.x = also does not work

@mjbvz mjbvz closed this as completed Mar 11, 2019
@mjbvz mjbvz added the upstream Issue identified as 'upstream' component related (exists outside of VS Code) label Mar 11, 2019
@ghost
Copy link
Author

ghost commented Apr 21, 2019 •
edited by ghost

Sorry my gifs missed the point... Please check again I just updated them.

@vscodebot vscodebot bot locked and limited conversation to collaborators Apr 25, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@mjbvz mjbvz

Labels
upstream Issue identified as 'upstream' component related (exists outside of VS Code)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mjbvz