汇道科技:前端编码一定要注意的规范

  当一个团队开始指定并实行编码规范的话,错误就会变得更加显而易见。这是因为一些程序员平常养成的编码不规范的小习惯导致的。如果一段特定的代码不符合规范的话,它有可能只是代码风格错误,而也有可能会是 bug。汇道科技:早期指定规范就使得代码审核得以更好的开展,并且可以更精确的地定位到错误。只要开发者们能够保证源代码源文件都严格遵循规范,那接下去所使用的混淆、压缩和编译工具则可投其所好不尽相同。

  1、文件/资源命名

  在 web 项目中,所有的文件名应该都遵循同一命名约定。以可读性而言,减号(-)是用来分隔文件名的不二之选。同时它也是常见的 URL 分隔符(i.e. //example.com/blog/my-blog-entry or //s.example.com/images/big-black-background.jpg),所以理所当然的,减号应该也是用来分隔资源名称的好选择。请确保文件命名总是以字母开头而不是数字。而以特殊字符开头命名的文件,一般都有特殊的含义与用处。资源的字母名称必须全为小写,这是因为在某些对大小写字母敏感的操作系统中,当文件通过工具压缩混淆后,或者人为修改过后,大小写不同而导致引用文件不同的错误,很难被发现。

  还有一些情况下,需要对文件增加前后缀或特定的扩展名(比如 .min.js, .min.css),抑或一串前缀(比如 3fa89b.main.min.css)。这种情况下,建议使用点分隔符来区分这些在文件名中带有清晰意义的元数据。

  不推荐

  MyScript.js

  myCamelCaseName.css

  i_love_underscores.html

  1001-scripts.js

  my-file-min.css

  推荐

  my-script.js

  my-camel-case-name.css

  i-love-underscores.html

  thousand-and-one-scripts.js

  my-file.min.css

  2、协议

  不要指定引入资源所带的具体协议。当引入图片或其他媒体文件,还有样式和脚本时,URLs 所指向的具体路径,不要指定协议部分(http:, https:),除非这两者协议都不可用。不指定协议使得 URL 从绝对的获取路径转变为相对的,在请求资源协议无法确定时非常好用,而且还能为文件大小节省几个字节。

  不推荐

  <scriptsrc="http: foundation.min.js?="" cdn.com="">

  推荐

  <scriptsrc=" foundation.min.js?="" cdn.com="">

  不推荐

  .example {

  background: url(http://static.example.com/images/bg.jpg);

  }

  推荐

  .example {

  background: url(//static.example.com/images/bg.jpg);

  }

  3、文本缩进

  一次缩进两个空格。

    • Fantastic
    • Great
    •   <ahref="#">Test

       

  @media screen and(min-width:1100px){

  body {

  font-size:100%;

  }

  }

  (function(){

  var x =10;

  function y(a, b){

  return{

  result:(a + b)* x

  }

  }

  }());

  4、注释

  注释是你自己与你的小伙伴们了解代码写法和目的的唯一途径。特别是在写一些看似琐碎的无关紧要的代码时,由于记忆点不深刻,注释就变得尤为重要了。编写自解释代码只是一个传说,没有任何代码是可以完全自解释的。而代码注释,则是永远也不嫌多。当你写注释时一定要注意:不要写你的代码都干了些什么,而要写你的代码为什么要这么写,背后的考量是什么。当然也可以加入所思考问题或是解决方案的链接地址。

  不推荐

  var offset =0;

  if(includeLabels){

  // Add offset of 20

  offset =20;

  }

  推荐

  var offset =0;

  if(includeLabels){

  // If the labels are included we need to have a minimum offset of 20 pixels

  // We need to set it explicitly because of the following bug: http://somebrowservendor.com/issue-tracker/ISSUE-1

  offset =20;

  }

  一些注释工具可以帮助你写出更好的注释。JSDoc 或 YUIDoc 就是用来写 JavaScript 注释用的。你甚至可以使用工具来为这些注释生成文档,这也是激励开发者们写注释的一个好方法,因为一旦有了这样方便的生成文档的工具,他们通常会开始花更多时间在注释细节上。

  5、代码检查

  对于比较宽松自由的编程语言来说,严格遵循编码规范和格式化风格指南就显得极为重要。遵循规范固然很好,但是有自动化流程来确保其执行情况,岂不更佳。Trust is good, control is better.对于 JavaScript,建议使用 JSLint 或 JSHint。

  汇道科技:以小见大,养成良好的习惯,在工作中你能事半功倍!

时间: 2024-10-31 01:07:36

汇道科技:前端编码一定要注意的规范的相关文章

汇道科技:一个小技巧让JAVA程序员顺利拿到理想Offer

有朋友跟我抱怨,明明平常对知识掌握的很精炼了,一到面试就会紧张,发挥失常,错失工作机会,这种情况就像"考前综合症",平常对知识点都掌握的很好,一到大场合就怯场,其实我们无论是在考试还是面试,都有很多技巧的.今天汇道科技小编分享一些面试技巧给各位程序员,让大家在面试时能更加得心应手,更顺利的拿到理想的offer. Java程序员面试的有哪些小技巧 01 笔试 笔试这个环节是很容易,一般由5至10个选择题+2至5个论述题+1至2个编程题组成. 我们保持平静心态--浏览所有题目--开答.答题

深圳汇道科技:新手不知道的入门编程的技术路线!速码!

不会设计的编程不是好前端,看着我们汇道科技的设计大神小哲与前端小宇又在为项目争执不下,小编不禁发出如此感慨,其实一个团队里面,项目都是环环相扣的,上一环节的参与者必须要懂得一些下一环节的相关知识,这样大家沟通起来才会更好更快!这就要求我们必须掌握多方面知识! 把编程单独拿出来说,编程不是一件无趣的事,它会给你带来无尽的欢乐.如果掌握不了多方面知识,那么我们可以把专业技能练到:精.致.特! 可是如何以最快的速度入门,这才是广大新手最关心的问题.本文就来谈谈编程入门的学习路线. 一.技术路线介绍 技

汇道科技:web新手快速入门JavaScript的技巧

我们在学习JavaScript,或其他任何编码技能的时候,往往是因为这些拦路虎而裹足不前:有些概念可能会造成混淆,尤其当你是从其他语言转过来的时候.找不到时间(有时是动力)学习.很容易忘记已经理解了的东西.工具多又在不断变化,所以不知道从哪里开始.幸运的是,这些拦路虎是可以被识别,并消灭的.在这篇文章中,汇道科技将介绍六个思维技巧来帮助你更快地学习JavaScript,并成为一个更快乐.更富有成效的程序员. 1.不要让未来的决策阻止你现在前进的方向 很多人学习JavaScript,问的第一个问题

汇道科技:而立之年,再来转行学软件开发来得及吗?

看到标题,一细想,边上转行的朋友不要太多,我举个身边人的例子吧.办公室的科科是一名标准的程序员,小编刚接触他的时候,只觉得这人沉默但专业技术过硬.当时心想是不是在这行待久了的人都是这样的.后来从别处了解到,原来科科也是"转行大军"中的一员,科科来汇道科技之前,是从事传统仪器测试行业的,转行的科科刚好处于而立之年. 很多人对于科科的转行之举表示很不理解,原因有三: 1.科科在原来那家公司也算高层领导,无论是从行业还是个人成就来看,都是值得让人羡慕的 2.转行的科科刚好处于而立之年,身边朋

汇道科技:如果以后程序员写不动代码了怎么办?

最近汇道科技办公室关于"程序员写不动代码了怎么办?"引发了很多人的讨论,一开始讨论的对象只是"当事人"程序员们,后面到各行各业,同时大家讨论的几个点也引人深思: 1.35岁写不动代码了怎么办?  你不得不承认,对于新事物的兴趣在下降,就如同不再有见漂亮姑娘时的小兔乱撞,就如同不再有见到梦想时的热血跌宕.就是如此尴尬的一个年龄,偏偏又生在互联网,这个到处都是常青藤生产线的艺术品,不比资历只比朝气的行业. 首先小编认为35岁并不是一个很可怕的年纪,三十而立,三十五岁正当

汇道科技:JAVA就业前景这么好,你还要让机会白白溜走吗?

很多来汇道科技咨询的朋友们问得最多的问题就是:Java培训就业前景如何?为什么越来越多的人选择IT行业,选择学习JAVA? Java作为编程语言排行榜冠军,是不容小视的.Java正慢慢地改变着全世界的生活.全球有30亿Java器件运行着Java,500多万Java开发者活跃在地球的每个角落,数十亿计的Web用户每次上网都亲历Java的威力.实际上,JAVA是一个发展迅速的新兴行业,Sun公司以及IBM.Oracle.Netscape等公司都在大力推进Java的应用.Java在WWW应用中的地位得

汇道科技:一个H5的辛酸成长史

什么?你还没有听过H5?你不知道什么叫H5?集图文.影音.游戏多种展示功能于一身的H5,因其在移动端传播方面的灵活性高.开发成本低.周期短等特性,已然成为企业营销的不二利器.为什么H5会越来越受欢迎呢?请听汇道科技小编给你一一道来! 从2014年的崭露头角,到如今成为用户互动必备元素.虽然圈内对H5的前景一片唱衰声,但在短短两年多的时间内,H5不仅在互动方式.展示内容上不断丰富,在视觉展示效果上也花样迭出,让人直呼惊艳的 H5不断涌现.那些好看的H5是怎么来的? 我们就从UI设计的角度,解读一个

汇道科技导师分享关于Java并发问与答!

自从java创建以来就已经支持并发的理念,如线程和锁.汇道科技小编分享的这篇指南主要是为帮助java多线程开发人员理解并发的核心概念以及如何应用这些理念. 1. 什么是原子操作?在Java Concurrency API中有哪些原子类(atomic classes)? 原子操作是指一个不受其他操作影响的操作任务单元.原子操作是在多线程环境下避免数据不一致必须的手段. int++并不是一个原子操作,所以当一个线程读取它的值并加1时,另外一个线程有可能会读到之前的值,这就会引发错误. 为了解决这个问

汇道科技:经历这五个学习阶段 成为Java技术大牛妥妥的!

互联网大数据时代飞速发展,IT行业的薪资待遇水涨船高,不少人都心生羡慕,纷纷选择向IT行业进军,其中特别活得就是JAVA大军,每年都有数以万计的各行各业的人转行学习JAVA,那么,一个零基础的人要怎么学习JAVA蜕变成技术大牛呢?我们看看汇道科技JAVA技术总监怎么说. 学习JAVA要分阶段学习,不同资历的人要根据本身实际情况去学习,主要分为这几个阶段: 第一阶段:基础阶段(Java基础) 你将要在这个阶段学会的技能: 软件行业信息了解. java的魅力和安装. 变量. 常量. 算术. 关系.