New Rule: prefer-jsdoc

[tjx666]

Rule details

jsdoc can provide useful documentation with IDE integration.

Related ECMAScript feature

no

What type of rule is this?

Enforces a formatting/stylistic preference

Example code

case one: object property

const person = {
    name: 'ly',
    // some description op top of property
    age: 18, // some description after property
};


case 2: typescript interface, should also work for type, enum

```typescript
interface Options {
    // default value is ['.js', '.ts']
    extensions: String[]; // default value is ['.js', '.ts']
}

case 3: function

// compute sum of two numbers
function add(a, b) {
    
}

Why should this rule be in the core instead of a plugin?

gajus/eslint-plugin-jsdoc#1002 (comment)

Participation

• I am willing to submit a pull request to implement this rule.

Additional comments

No response

[aladdin-add]

Per our rules policies, we can only accept new rules if they relate to new ECMAScript features that reached stage 4 in the preceding 12 months, so this proposal doesn't qualify. You can always make a custom rule and publish a plugin.