Skip to content

jsdoc comments - remove hyphen separator #44956

Closed
@atanasster

Description

@atanasster

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions