Skip to content

jsdoc comments - remove hyphen separator #44956

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

Closed
atanasster opened this issue Jul 9, 2021 · 0 comments · Fixed by #47777
Closed

jsdoc comments - remove hyphen separator #44956

atanasster opened this issue Jul 9, 2021 · 0 comments · Fixed by #47777
Labels
Experience Enhancement Noncontroversial enhancements Suggestion An idea for TypeScript
Milestone

Comments

@atanasster
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Experience Enhancement Noncontroversial enhancements Suggestion An idea for TypeScript
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants