Vue 項目中開啟 ESLint 之后,為了達到更好的代碼風格一般需要注釋。Vue ESLint 內置了常見的 HTML 注釋檢查規則,以及必要的 JS 規則,如果你需要自定義注釋規則也可以在 `.eslintrc.js` 文件中進行配置。
以下是 Vue ESLint 官方提供的注釋規則:
// @繼承 // @覆蓋 // @重載 // @說明 // @deprecated // @私有 // @共有 // @保護 // @access
其中, `@access` 注釋只在 `typescript-eslint/no-extraneous-class` 規則啟用時才會被使用。
自定義注釋規則時,需要在 `.eslintrc.js` 文件中的 rules 字段中進行配置。
module.exports = { // ... rules: { 'vue/custom-comment': ['error', { 'matchDescription': '^// ?@desc (.*)', 'matchComponent': '^// ?@component (.*)' }] } }
上面的例子中自定義了 `vue/custom-comment` 規則,并匹配規則注釋中包含 `@desc` 或者 `@component` 字段,從而配置了自定義的注釋規則。