CSS如何通过BEM命名规范提高代码的自注释能力_减少样式表中的注释量

雨晨君_3948

雨晨君_3948

2026-04-17

497人浏览

原创

bem类名自带语义,可替代三类注释:“组件归属”“dom层级限制”“状态说明”;但非直观兼容、跨端联动、临时hack及modifier隐含约束仍需注释。

css如何通过bem命名规范提高代码的自注释能力_减少样式表中的注释量

直接说结论:BEM本身不写注释,但类名自带语义,card__title--warning 比 h2.red 更容易让人秒懂用途,自然就少写甚至不用写 CSS 注释。

为什么类名能替代部分 CSS 注释

BEM 把结构关系、层级归属、状态含义全塞进类名里,浏览器不关心你有没有注释,它只认类名是否匹配——而人眼扫一眼类名,就能还原出“这是卡片里的标题,当前是警告态”。传统写法里 .title-red 这种命名,得靠注释说明“用于错误提示的标题”,而 form-field__label--error 自己就说清了。

  • 类名即上下文:header__logo 不用注释“这是页头的 logo”,user-avatar__initials 也不用解释“显示用户首字母”
  • Modifier 直接表达状态:button--disabled 比 .btn[disabled] + 注释“禁用态样式”更可靠,因为后者依赖 HTML 属性存在,前者只要加了类就生效
  • Element 名强制聚焦角色而非样式:search-form__clear 明确是“清空按钮”,不是 btn-icon 这种靠注释才能猜用途的泛称

哪些注释可以安全删掉

团队落地 BEM 后,以下三类 CSS 注释大概率可删,且不会影响后续维护:

CSS婚礼策划服务机构宣传网站模板
CSS婚礼策划服务机构宣传网站模板

CSS婚礼策划服务机构宣传网站模板是一款适合提供婚礼策划和婚庆服务机构宣传网站模板下载。提示:本模板调用到谷歌字体库,可能会出现页面打开比较缓慢。

下载
  • “这个样式属于 XX 组件”——类名里已有 product-card__price,无需再写 /* 产品卡片价格 */
  • “该元素在 XX 容器下才生效”——BEM 不依赖 DOM 层级,.sidebar__item 不会因挪到 .main 下就失效,不用注释“仅限侧边栏使用”
  • “此样式用于禁用态”——input--disabled 已含状态语义,不必额外加 /* 禁用时隐藏边框 */

但别误以为“完全不用写注释”

BEM 解决的是“类名意图模糊”问题,不是“所有逻辑都自解释”。这些地方仍需注释:

  • 非直观的视觉妥协:/* 为兼容 Safari flex gap,额外加 1px margin-top */
  • 跨组件联动逻辑:/* 与 JS 的 data-state="loading" 同步,避免样式/行为不一致 */
  • 临时 hack 或待修复项:/* TODO: 移除,待 antd v5.12 支持 CSS vars */
  • Modifier 的隐含约束:/* 注意:card--featured 必须配合 card__image 使用,否则布局错位 */

真正难的是让团队所有人写出语义清晰的 Element 名——比如把 user-card__delete-btn 改成 user-card__action--delete,这种细节没人盯就容易退化。类名一旦带行为动词或样式词(big、left),自注释能力立刻打折扣。

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关专题

更多
css
css

css是层叠样式表,用来表现HTML或XML等文件样式的计算机语言,不仅可以静态地修饰网页,还可以配合各种脚本语言动态地对网页各元素进行格式化。php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

4476

6

css居中
css居中

css居中:1、通过“margin: 0 auto; text-align: center”实现水平居中;2、通过“display:flex”实现水平居中;3、通过“display:table-cell”和“margin-left”实现居中。本专题为大家提供css居中的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.27

977

5

css如何插入图片
css如何插入图片

cssCSS是层叠样式表(Cascading Style Sheets)的缩写。它是一种用于描述网页或应用程序外观和样式的标记语言。CSS可以控制网页的字体、颜色、布局、大小、背景、边框等方面,使得网页的外观更加美观和易于阅读。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.28

1838

6

css超出显示...
css超出显示...

在CSS中,当文本内容超出容器的宽度或高度时,可以使用省略号来表示被隐藏的文本内容。本专题为大家提供css超出显示...的相关文章,相关教程,供大家免费体验。

2023.08.01

3486

7

css字体颜色
css字体颜色

CSS中,字体颜色可以通过属性color来设置,用于控制文本的前景色,字体颜色在网页设计中起到很重要的作用,具有以下表现作用:1、提升可读性;2、强调重点信息;3、营造氛围和美感;4、用于呈现品牌标识或与品牌形象相符的风格。

2023.08.10

7005

11

什么是css
什么是css

CSS是层叠样式表(Cascading Style Sheets)的缩写,是一种用于描述网页(或其他基于 XML 的文档)样式与布局的标记语言,CSS的作用和意义如下:1、分离样式和内容;2、页面加载速度优化;3、实现响应式设计;4、确保整个网站的风格和样式保持统一。

2023.08.10

5951

7

css三角形怎么写
css三角形怎么写

CSS可以通过多种方式实现三角形形状,本专题为大家提供css三角形怎么写的相关教程,大家可以免费体验。

2023.08.21

2017

9

css设置文字颜色
css设置文字颜色

CSS(层叠样式表)可以用于设置文字颜色,这样做有以下好处和优势:1、增加网页的可视化效果;2、突出显示某些重要的信息或关键字;3、增强品牌识别度;4、提高网页的可访问性;5、引起不同的情感共鸣。

2023.08.22

2831

5

css禁止点击事件
css禁止点击事件

实现css禁止点击事件的方法有使用CSS的pointer-events属性和使用JavaScript禁用点击事件。本专题为大家提供点击事件相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.23

2473

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Sass 教程
Sass 教程

共14课时 | 1.5万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 5.9万人学习

CSS教程
CSS教程

共754课时 | 96.7万人学习