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.

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

Highlight invalid params in doc comments #30182

Closed
benlesh opened this issue Mar 2, 2019 · 2 comments
Closed

Highlight invalid params in doc comments #30182

benlesh opened this issue Mar 2, 2019 · 2 comments
Labels
Duplicate An existing issue was already created

Comments

@benlesh
Copy link

benlesh commented Mar 2, 2019

Working on Angular, the team has mostly been very, very on-it with updating doc comments in great detail. However, it's been said by WebStorm users on our team that they catch a lot of invalid params docs, and or missing params docs because WebStorm has a feature that hightlights those issues, and VS Code users haven't had that feature so we miss things sometimes. (Sorry to make a comparison, this is just where the idea came up)

Example

/**
 * This method takes arguments and does basically nothing with them. :)
 * @param b The string that we do nothing with
 * @param c A dearly departed argument that should no longer be documented.
 */
function foo(a: number, b: string) {
}

Ideally in the above example, VS Code would catch two problems:

  1. a is missing a param entry in the doc comment
  2. c is no longer an argument and should be highlighted for removal.
@vscodebot vscodebot bot assigned mjbvz Mar 2, 2019
@mjbvz mjbvz transferred this issue from microsoft/vscode Mar 2, 2019
@mjbvz mjbvz removed their assignment Mar 2, 2019
@mjbvz
Copy link
Contributor

mjbvz commented Mar 2, 2019

Duplicate of #11378 I believe

@typescript-bot
Copy link
Collaborator

This issue has been marked as a 'Duplicate' and has seen no recent activity. It has been automatically closed for house-keeping purposes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Duplicate An existing issue was already created
Projects
None yet
Development

No branches or pull requests

4 participants