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
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. */functionfoo(a: number,b: string){}
Ideally in the above example, VS Code would catch two problems:
a is missing a param entry in the doc comment
c is no longer an argument and should be highlighted for removal.
The text was updated successfully, but these errors were encountered:
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
Ideally in the above example, VS Code would catch two problems:
a
is missing a param entry in the doc commentc
is no longer an argument and should be highlighted for removal.The text was updated successfully, but these errors were encountered: