编码规范

黄金定律

永远遵循同一套编码规范--不管有多少人共同参与同一项目,一定要确保每一行代码都像是同一个人编写的。

语法

  • 用两个空格来代替制表符(tab) -- 这是唯一能保证在所有环境下获得一致展现的方法。
  • 嵌套元素应当缩进一次(即两个空格)。
  • 对于属性的定义,确保全部使用双引号,绝不要使用单引号。
  • 不要在自闭合元素的尾部添加斜线。
  • 不要省略可选的结束标签(closing tag)(例如</body>)。

命名规范

  • 1.必须标注文档类型 <!DOCTYPE html>
  • 2.尽可能为文档标注语言属性 <html lang="zh-CN">
  • 3.明确声明字符编码 <meta charset="UTF-8">
  • 4.代码要符合语义化,并且尽量使用最少的标签并保持最小的复杂度。
  • 5.涉及到引号一律使用双引号,命名一律使用小写,连接单词一律用中横线-,
  • 6.为选择器分组时,将单独的选择器单独放在一行。每个属性也单独放在一行
.header,
.content,
.footer{
padding:10px;
}
  • 7.可缩写的属性尽可能使用缩写,值为0的属性省略单位,小于1的小数可省略前面的0
  /*padding:0px 15px 0px 15px;
  color: #ffffff;
  background-color: rgba(255, 0, 0, 0.5);*/

  padding:0 15px;
  color: #fff;
  background-color: rgba(255, 0, 0, .5);

命名方式

  • 命名是功能的描述,如果不知道如何命名,把你能想到的中文名字翻译成看着最顺眼的英文
  • 对于功能复杂的命名,可使用”是什么-什么特性”的命名方式,如”text-lesser”代表样式地位更轻一点的文本,”dialog-open”代表打开了的弹窗
  • 可充分利用语意化标签,配合直接子元素选择器去定位元素,省去一部分元素的命名

部分命名经验

wrap – 用于外侧包裹
header或者** head** – 用于头部
main – 用于主体
container或** ct** – 包裹容器
aside – 用于侧边栏
nav – 用于导航条
tab – 用于Tab切换选项卡
content – 和header footer 对应,用于主要内容
footer或者foot – 用于尾部
ad – 广告
subnav – 二级导航
menu – 菜单
tag – 标签
message或者notice – 提示消息
summary– 摘要
logo– logo
search– 搜索框
login – 登录
register– 注册
username– 用户名
password– 密码
dropmenu – 下拉菜单
banner – 广告条
copyright – 版权
modal或者 dialog – 弹窗
tooltip – 鼠标放置上去的提示

JS命名规约##

  • 1.标识符
  • 区分大小写
  • 第一个字符必须是字母、下划线(_)、或者是$
  • 后面的可以是字母、数字、下划线、$
  • 2.使用是实际意义的单词
  • 3.变量使用驼峰规则,第一个单词首字母小写,后面单词首字母大写
  • 4.变量使用名词,方法函数使用动词开头,常量全部用大写字母,函数创建对象首字母大写

参考自:
编码规范 by @mdo
HTML class id 如何命名by若愚@饥人谷

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,445评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,889评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,047评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,760评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,745评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,638评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,011评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,669评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,923评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,655评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,740评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,406评论 4 320
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,995评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,961评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,197评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,023评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,483评论 2 342

推荐阅读更多精彩内容