在我们的 eslint 规则中我们有这样的:
'multiline-comment-style': ['error', 'separate-lines'],
不允许这样的评论:
/* Some
comment */
赞成这一点:
// Some
// comment
问题在于,通过将块注释编写为 JSDoc 可能会忽略此规则。所以这是可能的:
/**
* Some
* comment
*/
我们也希望禁止这种行为。有什么办法可以做到这一点,或者也许可以使用一些插件?我能找到的所有信息都是如何要求 JSDoc,但不是如何禁止它。有什么建议吗?
此问题与 JSDoc 程序无关,而是 ESLint 配置的配置问题。
要禁止 ESLint 中的多行注释,请确保将
multiline-comment-style
设置为 ["error", "separate-lines"]
。
如果您需要有关此配置选项的更多信息,您可以在 ESLint | 找到文档。文档 |多行注释风格