HTML5中警告性注释需用FIXME、WARNING、TODO等前缀,如,确保可被工具识别、搜索和跳转,避免模糊描述,须明确影响范围与修复指引。
HTML5本身不支持语义化警告注释语法,所有注释都只是,
浏览器和工具不会解析其中含义。所谓“警告信息”,完全靠人眼识别,必须靠约定俗成的格式让后续维护者一眼看出这是需要警惕的地方。
TODO、FIXME、WARNING开头的注释最有效这类前缀是前端团队广泛接受的信号词,构建工具(如ESLint配合HTML插件)、编辑器(VS Code高亮TODO)、甚至Git提交扫描都能识别。重点不是“写得漂亮”,而是“能被搜到、能被跳转”。
FIXME:表示这里逻辑有缺陷,但暂时绕过,比如
WARNING:提示潜在风险,比如
TODO:明确待办,比如
很多注释失败是因为只写了“为什么当时这么写”,却没告诉别人“现在该怎么处理”。维护者看到毫无行动指引;而才真正有用。
标签包裹,方便搜索定位单靠人工阅读注释效率极低。把FIXME类注释变成可交互线索,才是关键。
TODO/FIXME,无需插件;想高亮WARNING,可在settings.json中加"todo-tree.regex.regex": "(//|#|