Appearance
require props to have a comment
This rule enforces that every prop has a comment that documents it.
{ "vue/require-prop-comment": ["error", { "type": "JSDoc" }] }
type
"JSDoc"
"line"
"block"
"any"
"type": "block"
"type": "line"
"type": "any"
vue/require-prop-comment #
📖 Rule Details #
This rule enforces that every prop has a comment that documents it.
🔧 Options #
type
... Type of comment. Default is"JSDoc"
"JSDoc"
... Only JSDoc comment are allowed."line"
... Only line comment are allowed."block"
... Only block comment are allowed."any"
... All comment types are allowed."type": "block"
#"type": "line"
#"type": "any"
#🔍 Implementation #