2019-06-23第二周周报-课堂笔记

js和css的代码规范

一、为什么要有规范

要首先排除一个误区,规范是:

1、跟性能无关

2、跟功能无关

3、跟结果无关

所谓代码规范是用来提高整个团队的开发效率,减少沟通成本,统一化代码编写方案,减少团队gap,保留团队最佳实践的团队建设的必须项之一。因此在制定规范之前,首先要明确规范是用来做什么的,确保团队成员心里能够有完全按照规范编写代码的意识。

二、规范的特点

1、易读性

这是规范首要追求的特性之一,易读性是保证代码可供团队快速,准确阅读的首要保障。是制定规范最重要的目标。

保证代码易读性需要注意的方面:

空格:


又例如:

中⽂文English数字01混合时

中⽂文 English 数字 01 混合时

可见加了空格之后,代码的结构更清晰,视觉感受更优,更容易把两者抽离出来,提高代码的可读性。心理学有一个相关性的概念,就是说,如果两个独立的事物在很短的时间内或者同时出现,人们下意识的就会认为这两件事物是有相关性的。因此在代码中,如果缺少空格,人眼就很容易将两段不同的代码认为是相关的,这样就需要动用额外的精力去判断两段代码之间的关系,造成不必要的成本。

空格的场景:注释符号与注释内容之间,css和object属性和属性值之间,操作符 = + -  && || (or more)两边...等等。

编码习惯:

编码习惯是在保证易读性的前提下,加入了团队和个人的一些特点,所形成的一系列编码规范。

比如一些css的属性顺序等。比如谷歌是按照属性名的首字母进行a-z的排序来编写,有些是按照定位-布局-大小-内容-修饰等分类来编写。

每一种编码习惯孰优孰劣见仁见智,但只要保证整个团队有一致的编码习惯就没问题。

代码命名:

这是保证代码易读性里,最重要的事情之一,每个好的代码规范都会对代码命名有着严苛的要求,命名可以分为以下几类:


例如

```

 myName = ""; 

studentNames = []; 

class CollageStudent {};

WIDTH = 200; HEIGHT = 300;

handleButtonClick() {};

canDelete = false; hasCar = true;

obj.__setName = () => {} ;

```

其实在命名的时候,代码的可读性有时比代码的简洁性更重要,比如createUserByNameAndEmail(name, email)这样的函数,尽管很长,但是一眼就容易让人看懂这个函数的作用。

2. 精简

精简的目的是能省则省,例如google里面对CSS属性值精简的例子:


例子太多,就不一一举例子了。

3. 严谨

这几年TS的火热,又把静态语言带入到各个JS语言开发者的视野当中,TS由于它的类型检查的机制,使得它对于一些核心业务代码,框架,组件等严谨性要求比较高的场合更加适合,减少一些不必要bug。不过过于追求严谨也会给团队带来不必要的麻烦,在大多数敏捷开发的场合,动态类型的JS更加适合。

三、最重要的一点

用什么代码规范不重要,最重要的是,团队能够统一代码规范,能够保证团队成员每个人能够编写出同样规则的代码。

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

推荐阅读更多精彩内容

  • 什么是html? html是一种网页标记语言,叫超文本标记语言,我们平时上网所看到的所有网页均来自于html,英文...
    波段顶底阅读 8,323评论 2 7
  • 编写灵活、稳定、高质量的 HTML 和 CSS 代码的规范。 ------HTML------ 语法 用两个空格来...
    littleyu阅读 509评论 0 1
  • Web 前端代码规范 最后更新时间:2017-06-25 原始文章链接:https://github.com/bx...
    白小明0927阅读 2,526评论 1 15
  • 不想追热点,但周杰伦的歌确实给我们的青春写下浓墨重彩的一笔。 有听过周董新歌的朋友可以在评论区讨论下感受,或者说一...
    梦醒惜年阅读 207评论 1 2
  • 再过一段时间,一年就又过去啦,可二货哥口袋还是空空的。 今天他找路边大师算了一卦。大师掐指一算,点头啧啧说到:“不...
    老罗xt阅读 280评论 0 2