十三·命名技巧和编码规范

1.命名技巧

1.如何命名

1.命名的原则:语义化标签优先
2.三种命名方式:基于功能命名、基于内容命名、基于表现命名。
3.命名的目的:简略、明了、无后患。
tips:遇见不会命名的可以直接用翻译软件翻译过来命名。
范例1:

<!-- 不好  -->
<div class="article">
  <div class="article_title">编码规范</div>
  <div class="the_content">今天讲的内容是编码规范,讲师
     <div class="darkbold">若愚</div> @饥人谷</div>
</div>
<!-- 好 -->
<article>
  <h1>编码规范</h1>
  <p>今天讲的内容是编码规范,讲师
     <b>若愚</b> @饥人谷</p>
</article>

范例2:

<!-- 不好  -->
<div class="left"></div>
<div class="red"></div>
<div class="s"></div>
<a class="link" href="#"></a>
<!-- 好 -->
<div class="success"></div>
<div class="theme-color"></div>
<a class="login" href="#"></a>

(尽量去基于功能来命名,而不是通过表现来命名,不容易修改)

<!-- 好 -->
<article class="movies">...</article>
<article class="news">...</article>
<!-- 不好 -->
<article class="blue">...</article>
<article class="redBg mt30 bigText">...</article>

2.命名方法:

1.所有命名都使用英文小写
推荐:<div class="main"></div>
不推荐: <div class="Main"></div>
2.命名用引号包裹
推荐:<div id="header"></div>
不推荐: <div id=header></div>
3.用中横线连接
推荐:<div class="mod-modal"></div>
不推荐: <div class="modModal"></div>
4.命名体现功能,不涉及表现样式(颜色、字体、边框、背景等)
推荐:<div class="text-lesser"></div>
不推荐: <div class="light-grey"></div>

3.常用命名:

.wrap或.wrapper -- 用于外侧包裹
.container或 .ct -- 包裹容器
.header -- 用于头部
.body -- 页面 body
.footer -- 页面尾部
aside、sidebar -- 用于侧边栏
.content -- 和header footer 对应,用于主要内容
.navigation -- 导航元素
.pagination -- 分页
.tabs > .tab -- tab 切换
.breadcrumbs -- 导航列表、面包屑
.dropdown -- 下拉菜单
.article -- 文章
.main -- 用于主体
.thumbnail -- 头像,小图像
.media -- 媒体资源
.panel -- 面板
.tooltip -- 鼠标放置上去的提示
.popup -- 鼠标点击弹出的提示
.button、.btn -- 按钮
.ad -- 广告
.subnav -- 二级导航
.menu -- 菜单
.tag -- 标签
.message或者.notice -- 提示消息
.summary -- 摘要
.logo -- logo
.search -- 搜索框
.login -- 登录
.register -- 注册
.username -- 用户名
.password -- 密码
.banner -- 广告条
.copyright -- 版权
.modal或者 .dialog -- 弹窗
var 名字 = {
状态: [ 'inverse', 'toggled', 'switched', 'original', 'initial', 'identified', 'disabled', 'loading', 'pending', 'syncing', 'default' ],
修饰: [ 'dark', 'light', 'shaded', 'flat', 'ghost', 'maroon', 'pale', 'intense', 'twisted', 'narrow', 'wide', 'smooth', 'separate', 'clean', 'sharp', 'aligned' ],
元素: [ 'pagination', 'modal', 'popup', 'article', 'story', 'flash', 'status', 'state', 'media', 'block', 'card', 'teaser', 'badge', 'label', 'sheet', 'poster', 'notice', 'record', 'entry', 'item', 'figure', 'square', 'module', 'bar', 'button', 'action', 'knob' ],
布局: [ 'navigation', 'wrapper', 'inner', 'header', 'footer', 'aside', 'section', 'divider', 'content', 'container', 'panel', 'pane', 'construct', 'composition', 'spacing', 'frame' ]
}

2.编码规范

1.书写规范

  • tab:用两个空格表示
  • css的:后加个空格, {前加个空格
  • 每条声明后都加上分号
  • 换行,而不是放到一行
  • 颜色用小写,用缩写, #fff
  • 小数不用写前缀, 0.5s -> .5s;0不用加单位
  • 尽量缩写, margin: 5px 10px 5px 10px -> margin: 5px 10px

2.范例

/* Not recommended */
.test {
  display: block;
  height: 100px;
}
/* Recommended */
.test {
  display: block;
  height: 100px;
}
/* Not recommended */
h3 {
  font-weight: bold;
}

3.参考文档

bootstrap编码规范

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 1. 命名技巧 - 语义化 语义化标签优先 基于功能命名、基于内容命名、基于表现命名 从前到后依次优先 简略、明了...
    愁容_骑士阅读 2,435评论 0 0
  • 1. 说一说平时写代码遵守的编码规范 首先,命名技巧 选用语义化的标签基于功能命名、基于内容命名、基于表现来命名总...
    andreaxiang阅读 1,222评论 0 0
  • 不管有多少人共同参与同一项目,一定要确保每一行代码都像是同一个人编写的。 ...
    青鸣阅读 2,593评论 0 1
  • 说一说你平时写代码遵守的编码规范 每个程序员都会有自己的编码习惯,但是几乎每个项目,各个公司都会有自己的编码规范,...
    DCbryant阅读 2,312评论 0 0
  • 昨天早上发生了不愉快的事情。儿子正常上午十点上课,因补课作业没写完我就8点半叫他起床在上课前完成作业,我着急作业的...
    上善若水wy阅读 1,527评论 0 0