如何为CSS BEM规范编写团队开发文档

大瑶吖_1028

大瑶吖_1028

2026-08-08

748人浏览

原创

团队文档必须可查、可校验、可同步,block名需用typescript或json schema强制约束,element名须表语义非结构,modifier需明确状态契约与兼容性,所有变更须自动触发清单更新、ci校验与文档生成。

如何为css bem规范编写团队开发文档

团队文档不是写给机器看的,而是防止人脑在三个月后对着 .user-card__title--featured 发呆——它必须能被快速查、被强制校验、被低成本同步。

怎么定义 Block 名清单并让它真正生效

Block 名不能靠“大家自觉遵守”,否则很快会出现 usr-card、userCard、user-card-v2 并存。必须收口到可执行的约束源:

  • 用 TypeScript interface 或 JSON Schema 明确声明所有公开 Block 名,例如 type BlockName = 'user-card' | 'date-picker' | 'filter-panel'
  • 所有 HTML 模板、CSS 类名、组件文件名(如 UserCard.vue)都必须与该清单对齐
  • 禁止在文档里写“推荐使用 card”,而要写“仅允许使用以下 Block 名:card、teaser、stat-badge”
  • CI 阶段用 stylelint-selector-bem-pattern 拦截非法类名,比如 .card .header 或 .user-card__title-large

Element 命名为什么不能靠 DOM 结构推断

看到 HTML 里 <div class="user-card"><div><h3 class="title"></h3></div></div> 就写 .user-card__title 是错的——Element 名必须反映语义角色,不是 DOM 深度:

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

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

下载
  • .user-card__name ✅(这是用户姓名,和位置无关)
  • .user-card__header-title ❌(“header”是结构词,不是业务角色;且嵌套命名违反 BEM 扁平原则)
  • .user-card__title ❌(歧义:是卡片标题?还是用户姓名?需结合上下文猜)
  • 如果一个 Element 内还要分 value 和 unit,说明它已具备独立逻辑,应拆成新 Block:stat-value 和 stat-unit

Modifier 文档里最常漏掉的兼容性说明

修饰符不是样式开关,而是状态契约。文档若只写“加 --large 变大”,下游开发者就会在响应式场景里误用:

  • button--large 应注明:“仅用于桌面端固定尺寸变体;移动端请配合 @media (max-width: 768px) 使用 button--compact”
  • card--featured 要明确:“触发此修饰符的 JS 逻辑必须同时设置 aria-current="true",否则无障碍失效”
  • 禁止出现纯视觉修饰符如 --blue、--small;文档中必须替换为业务语义,如 --brand、--compact
  • 所有 Modifier 必须在 CSS 文件中与对应 Block/Element 同文件定义,不许跨文件拼接(例如 card.css 里定义 .card--featured,不许在 theme.css 里覆盖)

真正难的不是写清楚规则,而是让每次改名、加元素、新增修饰符时,都自动触发清单更新、CI 校验、文档生成三件事——否则文档半年后就只是个纪念品。

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

相关文章

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

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

下载

相关标签:

css css开发 css教程

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

相关专题

更多
css
css

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

2023.06.15

4996

6

css居中
css居中

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

2023.07.27

1077

5

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

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

2023.07.28

1958

6

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

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

2023.08.01

3826

7

css字体颜色
css字体颜色

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

2023.08.10

7865

11

什么是css
什么是css

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

2023.08.10

6651

7

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

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

2023.08.21

2217

9

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

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

2023.08.22

3191

5

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

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

2023.08.23

2793

5

热门下载

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

精品课程

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

共14课时 | 1.5万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 6万人学习

CSS教程
CSS教程

共754课时 | 98.6万人学习