Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

css 规范

1. 命名规范

  • id 和 class

    • 三种命名(用英文,尽量不缩写)
      • 驼峰: topMain, subLeftMenu
      • (id 用)中划线: top-main, sub-left-menu
      • (class 用)下划线: top_main, sub_left_menu
  • 组合方式:

    • 命名空间-形容词-块-元素--特殊形容词
  • 命名空间

    • 布局:以 layout 开头
    • 模块:以 mod 开头
    • 元件:以 cell 开头
  • 形容词

    形容词方位
    top
    main
    sub
    side
    • 避免用某些位词,比如 left/right
    • 多改用语义词,比如 main/side
  • 块-名词

    • 结构性块
    结构名词结构名词结构名词
    整页wrapper
    头部header导航nav脚部footer
    主体main
    侧栏sidebar容器container栏目column
    • 功能性块 功能 | 名词 | 功能 | 名词 | 功能 | 名词

    • | - | - | - | - | - 登录 | login | 注册 | register | 搜索 | search 指南 | guild | 列表 | list | 链接 | link 按钮 | btn | 密码 | pwd | 广告 | banner

    • 前置功能性块 功能 | 名词 | 功能 | 名词 | 功能 | 名词

    • | - | - | - | - | - 标志 | logo- | 图标 | icon- | 背景 | bg-

  • 元素-名词 元素 | 名词 | 元素 | 名词 | 元素 | 名词

    • | - | - | - | - | - 项 | -item 头部 | -hd | 标题 | -title | 底部 | -btm 内容 | -cont

2.书写规范

按如下 4 种类型,顺序书写

  • 位置类

    position:
    (top/right/bottom/left):
    transform: translate(x,y)
    display:
    align-items:
    justify-content:
    float:
    overflow-x/y:
    z-index:
    
  • 尺寸类

    box-sizing:content-box/border-box
    width/height: vh/vw/100%
    margin/padding/border:
    
  • 字体类:

    font-(family/size/weight):
    line-height:
    text-indent:
    text-align:
    vertical-align:
    white-space:
    text-overflow:
    
  • 颜色类

    color:
    background-color:
    background-(size/position/image/repeat):
    opacity:
    cursor:
    
  • 关于 reset 规范

    • Eric Meyer 发布的重置样式表
      • 可以参考其中的部分样式,放到自己的 body 中

3. 注释规范

  • 顶部注释

    • 包含文件的基本信息
  • 模块注释

    • 开始时写一行 /* 注释开始 */
    • 结束时写一行 /* 注释结束 */
  • 功能代码注释

    • 可 单行 或 多行
  • 注意

    • 在 webpack 压缩发布后,注释代码会被清除

      • 保留的办法: 内容最前面加 !
    • 不支持 // 的注释