Skip to content


require props to have a comment

📖 Rule Details

This rule enforces that every prop has a comment that documents it.

Now loading...

🔧 Options

  "vue/require-prop-comment": ["error", {
    "type": "JSDoc"
  • 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"

Now loading...

"type": "line"

Now loading...

"type": "any"

Now loading...

🚀 Version

This rule was introduced in eslint-plugin-vue v9.8.0

🔍 Implementation