如何禁止对象字面量中注释属性？强制使用多行块注释

1. 禁止对象内注释掉的冗余属性 #

要杜绝这种注释属性而非删除的情况，最直接的方式是通过ESLint配置规则，检测并报错对象字面量中被注释掉的代码行：

• 可以使用ESLint的no-commented-out-code规则，或者自定义规则专门扫描对象字面量内的单行注释。只要注释内容匹配属性定义格式（比如以逗号结尾、符合变量名结构），就抛出错误。

自定义规则核心逻辑示例：

module.exports = {
  create(context) {
    return {
      ObjectExpression(node) {
        const comments = context.getCommentsInside(node);
        comments.forEach(comment => {
          if (comment.type === 'LineComment' && /^\s*\w+.*,$/.test(comment.value)) {
            context.report({
              node: comment,
              message: '禁止在对象内注释属性，请直接删除无用属性'
            });
          }
        });
      }
    };
  }
};

2. 禁用单行注释，强制使用多行块注释 #

如果要全局禁用单行注释（//），强制使用多行块注释（/* */），可以配置ESLint的line-comment-style规则：

在ESLint配置文件中添加：

{
  "rules": {
    "line-comment-style": ["error", "block"]
  }
}

这个规则会强制所有注释都用块注释格式，开发者用Ctrl + #这类单行注释快捷键生成的内容会直接触发ESLint错误，从操作习惯上减少这类冗余注释的产生。

补充说明 #

• 若需要保留对象内的说明性注释，可在自定义规则中添加例外：允许块注释，仅禁止单行注释的属性内容。
• 结合版本控制工具，完全可以要求开发者直接删除无用属性，历史代码可通过版本记录回溯，无需保留注释掉的冗余代码。

内容的提问来源于stack exchange，提问作者Moritz Roessler