-
Notifications
You must be signed in to change notification settings - Fork 12.9k
Closed
Labels
Experience EnhancementNoncontroversial enhancementsNoncontroversial enhancementsSuggestionAn idea for TypeScriptAn idea for TypeScript
Milestone
Description
Suggestion
Remove the hypen separator from jsdoc property comments
Suggested in #44932 to open this for discussion
According to https://jsdoc.app/tags-param.html space-hyphen-space is a standard separator for the @param
tag
Example:
**
* Assign the project to an employee.
* @param {string} name - The name of the assigned person
*/
Project.prototype.assign = function(name) {
// ...
};
will parse the param comment as - The name of the assigned person
, the suggestion is to clean up the comment to The name of the assigned person
Nixinova, LJMSU, GoogleFeud and a-tarasyuk
Metadata
Metadata
Assignees
Labels
Experience EnhancementNoncontroversial enhancementsNoncontroversial enhancementsSuggestionAn idea for TypeScriptAn idea for TypeScript