eslint-plugin-vue

外观

vue/require-prop-comment ​

要求 props 具有注释

📖 规则详细信息 ​

此规则强制执行每个 prop 都有一个注释来记录它。

正在加载...

🔧 选项 ​

json
{
  "vue/require-prop-comment": ["error", {
    "type": "JSDoc"
  }]
}
  • type ... 注释类型。默认值为 "JSDoc"
    • "JSDoc" ... 仅允许 JSDoc 注释。
    • "line" ... 仅允许行注释。
    • "block" ... 仅允许块注释。
    • "any" ... 允许所有注释类型。

"type": "block" ​

正在加载...

"type": "line" ​

正在加载...

"type": "any" ​

正在加载...

🚀 版本 ​

此规则是在 eslint-plugin-vue v9.8.0 中引入的

🔍 实现 ​