时间: 2013-10-09 / 分类: WEB前端开发 - 用户体验设计 / 浏览次数: / 2 个评论 发表评论
WEB前端开发中的一些编程风格和书写规范,编写可维护的Javascript
项目前端开发的架构
WEB前端开发中的一些编程风格和书...
CSS Hack浏览器兼容IE6+IE7+IE8+IE9+FF
12条经典摄影技巧
WEB前端开发中的一些编程风格和书写规范也是需要注意的,一直以来,有规有矩,推荐重在统一!
不太建议不同的人写出各种不一样的风格,如果一个团队中不同的人写出的风格就像一个人写出来的一样,写出的代码读起来非常顺心,非常易懂,那就非常的爽了。
这里是一些前端开发过程中的编程风格和书写规范,不分IDE,但是可以考虑在不同的IDE中遵照和执行
推荐《编写可维护的Javascript》
1 编程风格和书写规范
1.1 代码格式化
1.1.1 推荐4个空格的缩进
1.1.1.1 (IDE编辑器中定义tab键用4个空格)
1.1.2 Javascript语句结尾不省略分号
1.1.2.1 (部署时候,压缩混淆时候可能会出错)
1.1.3 建议行长度限定在80个字符
1.1.4 换行
1.1.4.1 原因:长度达到单行最大字符数,需要手动一行拆两行
1.1.4.2 处理:在运算符(如,&&||)之后换行,第二行追加两个缩进(即8个字符)
1.1.4.3 例外:当给变量赋值时,第二行的位置应当和赋值运算符(如=号)的保持对齐
1.1.5 空行(为了可读性)
1.1.5.1 在每个方法之间
1.1.5.2 在每个流控制语句之前(如if和for语句之前)
1.1.5.3 在方法的局部变量和第一条语句之间
1.1.5.4 在多行注释和单行注释之前
1.1.5.5 在方法内的逻辑片段之间插入空行,提高可读性
1.1.6 命名
1.1.6.1 小驼峰式大小写CamelCase命名法-小写字母开头,后续每个单词首字符大写,如thisIsMyName
1.1.6.2 变量命名
1.1.6.2.1 前缀应当是名词
1.1.6.2.2 原则
1.1.6.2.2.1 命名长度尽可能短,并抓住要点
1.1.6.2.2.2 能在变量命名中体现值的数据类型
1.1.6.2.2.2.1 数字:count,length,size
1.1.6.2.2.2.2 字符串:name,title,message
1.1.6.2.2.2.3 循环:i,j,k
1.1.6.2.2.2.4 布尔值:can,has,is,get,set
1.1.6.3 函数命名:前缀应当是动词
1.1.6.4 常量(JS非严格意义上的初始化后不变的值)命名:使用大写字母和下划线来命名,下划线来分隔单词
1.1.6.5 构造函数:大驼峰式大小写(PascalCase):大写字母开头,后续每个单词首字母大写,命名基本使用名词
1.1.7 直接量
1.1.7.1 字符串
1.1.7.1.1 双引号和单引号在功能上无区别,只需代码从头到尾保持一种风格
1.1.7.1.2 多行字符串,应该用字符串连接符(+)将字符串分成多份
1.1.7.2 数字
1.1.7.2.1 不要省略小数点前和小数点后的数字
1.1.7.2.2 禁止使用八进制直接量
1.1.7.3 null(相当于对象的placeholder占位符)
1.1.7.3.1 应当用的场景
1.1.7.3.1.1 用来初始化一个变量,此变量可能赋值为一个对象, 如var person=null;
1.1.7.3.1.2 用来和一个已经初始化的变量比较,此变量有可能是或不是一个对象 var person=getPerson();if(person!=null){…}
1.1.7.3.1.3 当函数的参数期望是对象时,用作参数传入
1.1.7.3.1.4 当函数的返回值期望是对象时,用作返回值传出 如return null;
1.1.7.3.2 不应当用的场景
1.1.7.3.2.1 不用使用null来检测是否传入了某个参数 function doSome(arg1,arg2,arg3,arg4){if(arg4!=null){…}}
1.1.7.3.2.2 不要用null来检测一个未初始化的变量 var person;if(person!=null){…}
1.1.7.4 undefined
1.1.7.4.1 容易和null搞混
1.1.7.4.2 避免在代码中使用undefined
1.1.7.5 对象直接量
1.1.7.5.1 好的写法
1.1.7.5.1.1 var book={title:””,author:”Amiku”};
1.1.7.5.2 不好的写法
1.1.7.5.2.1 var book=new Object(); book.title=”Javascript”; book.author=”Amiku”;
1.1.7.6 数组直接量
1.1.7.6.1 好的写法
1.1.7.6.1.1 var colors=[“red”,”green”,”blue”]; var numbers=[1,2,3,4]
1.1.7.6.2 不好的写法
1.1.7.6.2.1 var colors=new Array(“red”,”green”,”blue”); var number=new Array(1,2,3,4);
1.2 注释
1.2.1 何时使用注释
1.2.1.1 当代码不够清晰时添加注释;当代码很明了不应当添加注释。
1.2.1.2 难于理解的代码,看情况有必要使用单行注释,多行注释或者混用
1.2.1.3 当代码看上去有错误或者一些特性的hack的时候,特意做出说明,防止被修改或者日后自己查看
1.2.1.4 文档注释,流行的做法用来自于JavaDoc文档格式,描述信息使用@符号来表示属性,也有YUIDoc,JSDoc等
1.2.1.4.1 所有的方法
1.2.1.4.2 所有的构造函数
1.2.2 如何使用注释
1.2.2.1 单行注释
1.2.2.1.1 独占一行的注释
1.2.2.1.1.1 来用解析下一行代码
1.2.2.1.1.2 这行注释之前总是有一个空行
1.2.2.1.1.3 缩进和下一行代码保持一致
1.2.2.1.1.4 双斜线后尽量有一个空格,让注释文本有一定的偏移
1.2.2.1.2 代码行尾部的注释
1.2.2.1.2.1 代码结束到注释之间至少有一个缩进(4个字符)
1.2.2.1.2.2 注释后的行,不应当超过单行最大字符数限制,如果超过,作为独占一行的注释
1.2.2.1.3 IDE编辑器批量注释的大断代码
1.2.2.2 多行注释
1.2.2.2.1 尽量使用Java的多行注释风格
1.2.2.2.1.1 /* * */
1.2.2.2.2 多行注释之前应当有一个空行,缩进与其描述的代码保持一致
1.2.2.2.3 代码尾巴不要使用多行注释格式
1.2.2.2.4 星号后尽量有空格
1.3 语句和表达式
1.4 变量
  1. Pingback: Cıvata

  站点地图 | 关于我 | 返回顶部
Copyright © 2001-2013 { amiku.cn | zhangshunjin.com }. Powered by 

阿米酷

张顺金


浙ICP备11002820号-1