如何编写清晰的CSS BEM命名规范文档?

星枫小哥_4673

星枫小哥_4673

2026-07-16

512人浏览

原创

bem 文档靠约束而非撰写——通过代码审查、自动化检查和三类命名模板实现。block 全小写连字符,element 用双下划线且不带逻辑词,modifier 仅描述状态/外观;eslint/stylelint 硬性校验,目录结构即契约,禁止跨层级命名。

如何编写清晰的css bem命名规范文档?

直接说结论:BEM 文档不是写出来的,是约束出来的——靠代码审查 + 自动化检查 + 三类命名模板,而不是靠长篇规则说明。

为什么 BEM 命名文档容易失效

多数团队写的 BEM 规范文档最后变成 PDF 存档,没人看,因为问题不在“不知道规则”,而在“改个 class 名要查文档、要猜语义、要问同事”。真实瓶颈是:命名决策成本高、重构时不敢动、新人加个 header__title--big 就破坏层级语义。

真正起作用的不是文档页数,而是:
• 提交前自动拦截非法命名(比如 btn-primary--large 没有 block 上下文)
• IDE 里输入 card__ 时自动提示合法修饰符(card__image / card__content)
• Code Review 时只问一句:“这个 class 能在 card 组件外复用吗?”

只保留三类可执行的命名模板

把所有 BEM 场景压缩成三个填空式结构,开发时照着套,不自由发挥:

  • Block:全小写 + 连字符,必须能独立存在 —— search-bar ✅,user-profile-card ✅,SearchBar ❌,searchBar ❌
  • Element:<block>__<element></element></block>,双下划线,元素名不带逻辑词(避免 header__title-wrapper)—— header__title ✅,header__title-text ✅,header__title-container ❌
  • Modifier:<block>--<modifier></modifier></block> 或 <block>__<element>--<modifier></modifier></element></block>,仅描述状态/外观,不描述位置或父级关系 —— button--disabled ✅,button__icon--rotated ✅,button--mobile ❌,sidebar__item--first ❌

用 ESLint + stylelint 实现硬性约束

文档里写一百条“不要嵌套超过三层”,不如让 stylelint 报错。关键配置项:

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

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

下载
  • 启用 stylelint-selector-bem-pattern 插件,正则设为 ^(?:[a-z][a-z0-9]*)(?:-[a-z0-9]+)*(__[a-z][a-z0-9]*)(?:-[a-z0-9]+)*(?:--[a-z][a-z0-9]*)(?:-[a-z0-9]+)*$(适配你团队的连字符风格)
  • 禁止 class 属性中出现空格分隔多个 block(如 class="header search-bar"),强制用 header__search-bar 或独立 block
  • 在 eslint-plugin-react 中开启 react/no-unescaped-entities 之外,加自定义 rule 检查 JSX 中 class 字符串是否匹配 BEM 正则(例如拦截 className="btn primary")

示例报错信息必须具体:Invalid BEM class 'userCard__avatar--large': modifier '--large' not allowed on element 'userCard__avatar' —— 不说“不符合规范”,直指哪部分违规。

组件目录结构即命名契约

文件路径就是隐式文档。一个 card 组件的目录必须长这样:

components/
└── card/
    ├── card.css
    ├── card.js
    ├── card__header.css
    ├── card__body.css
    └── card__footer.css

如果出现 card__header__title.css,就违反了 BEM 原则(header 是 element,不能再有子 element),CI 直接 fail。同理,card--featured.css 可以存在,card-header--sticky.css 不允许 —— 因为 card-header 本身不是 block。

复杂点在于:当多个组件共用同一视觉样式(比如所有 __title 都需要统一字号),别提取公共 class,而是用 CSS 自定义属性 + :where() 控制,保持 class 名称语义纯净。否则,命名权就从组件移交给了设计师的视觉稿,BEM 就退化成“换个名字而已”。

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

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
css
css

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

2023.06.15

4616

6

css居中
css居中

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

2023.07.27

1017

5

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

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

2023.07.28

1878

6

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

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

2023.08.01

3586

7

css字体颜色
css字体颜色

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

2023.08.10

7265

11

什么是css
什么是css

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

2023.08.10

6151

7

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

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

2023.08.21

2077

9

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

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

2023.08.22

2931

5

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

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

2023.08.23

2553

5

热门下载

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

精品课程

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

共14课时 | 1.5万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 5.9万人学习

CSS教程
CSS教程

共754课时 | 97.3万人学习