@@ -72,39 +72,50 @@ Add `plugins` section and specify `eslint-plugin-jsdoc` as a plugin.
72
72
73
73
Finally, enable all of the rules that you would like to use.
74
74
75
- ``` json
75
+ ``` javascript
76
76
{
77
77
" rules" : {
78
- "jsdoc/check-alignment" : 1 ,
78
+ " jsdoc/check-alignment" : 1 , // Recommended
79
79
" jsdoc/check-examples" : 1 ,
80
80
" jsdoc/check-indentation" : 1 ,
81
- "jsdoc/check-param-names" : 1 ,
81
+ " jsdoc/check-param-names" : 1 , // Recommended
82
82
" jsdoc/check-syntax" : 1 ,
83
- "jsdoc/check-tag-names" : 1 ,
84
- "jsdoc/check-types" : 1 ,
85
- "jsdoc/implements-on-classes" : 1 ,
83
+ " jsdoc/check-tag-names" : 1 , // Recommended
84
+ " jsdoc/check-types" : 1 , // Recommended
85
+ " jsdoc/implements-on-classes" : 1 , // Recommended
86
86
" jsdoc/match-description" : 1 ,
87
- "jsdoc/newline-after-description" : 1 ,
87
+ " jsdoc/newline-after-description" : 1 , // Recommended
88
88
" jsdoc/no-types" : 1 ,
89
- "jsdoc/no-undefined-types" : 1 ,
89
+ " jsdoc/no-undefined-types" : 1 , // Recommended
90
90
" jsdoc/require-description" : 1 ,
91
91
" jsdoc/require-description-complete-sentence" : 1 ,
92
92
" jsdoc/require-example" : 1 ,
93
93
" jsdoc/require-hyphen-before-param-description" : 1 ,
94
- "jsdoc/require-jsdoc" : 1 ,
95
- "jsdoc/require-param" : 1 ,
96
- "jsdoc/require-param-description" : 1 ,
97
- "jsdoc/require-param-name" : 1 ,
98
- "jsdoc/require-param-type" : 1 ,
99
- "jsdoc/require-returns" : 1 ,
100
- "jsdoc/require-returns-check" : 1 ,
101
- "jsdoc/require-returns-description" : 1 ,
102
- "jsdoc/require-returns-type" : 1 ,
103
- "jsdoc/valid-types" : 1
94
+ " jsdoc/require-jsdoc" : 1 , // Recommended
95
+ " jsdoc/require-param" : 1 , // Recommended
96
+ " jsdoc/require-param-description" : 1 , // Recommended
97
+ " jsdoc/require-param-name" : 1 , // Recommended
98
+ " jsdoc/require-param-type" : 1 , // Recommended
99
+ " jsdoc/require-returns" : 1 , // Recommended
100
+ " jsdoc/require-returns-check" : 1 , // Recommended
101
+ " jsdoc/require-returns-description" : 1 , // Recommended
102
+ " jsdoc/require-returns-type" : 1 , // Recommended
103
+ " jsdoc/valid-types" : 1 // Recommended
104
104
}
105
105
}
106
106
```
107
107
108
+ You may also use the following which enables the rules commented
109
+ above as "recommended":
110
+
111
+ ``` json
112
+ {
113
+ "extends" : [" plugin:jsdoc/recommended" ]
114
+ }
115
+ ```
116
+
117
+ You can then selectively add to or override the recommended rules.
118
+
108
119
## Settings
109
120
110
121
### Allow ` @private ` to disable rules for that comment block
0 commit comments