sindresorhus/eslint-plugin-unicorn
Rule proposal: Doc comment asterisk prefix style
Fermée
#1 607 ouverte le 11 nov. 2021
help wantednew rule
Métriques du dépôt
- Stars
- (5 022 étoiles)
- Métriques de merge PR
- (Merge moyen 1j 16h) (399 PRs mergées en 30 j)
Description
Description
I prefer not using asterisk prefix on doc comments as I find them noisy and they also make it much harder to edit comments.
I'm aware you can almost get this with the JSDoc ESLint plugin, but it's a bit heavy to add that just for this and doc comments do not necessarily need to be JSDoc, so this rule would be more general.
Fail
/**
* Add two numbers.
* @param {number} num1 The first number.
* @param {number} num2 The second number.
* @returns {number} The sum of the two numbers.
*/
Pass
/**
Add two numbers.
@param {number} num1 The first number.
@param {number} num2 The second number.
@returns {number} The sum of the two numbers.
*/
(Notice how */ moved too)