js编码规范

使用统一的 编码规范 编写代码能提高JS代码的可读性,利于后期的维护和扩展,利于团队开发。

引用规范:

1、采用<script>...</script>方式引入 *.js 文件,避免在html中内嵌js代码;

原因在于这样做可以利用 浏览器 的Cache(缓存)避免页面刷新而重新加载,对于JS代码来讲是没有必要的,反而是加大了文件的传输量;

2、js代码采用分多个文件引入的方法,这样可以避免因局部代码修改而引发的重复调用;

命名规范:

原则是:以最少的字母达到最容易理解的意义。

1、变量声明

♦ 所有代码在使用前应将变量声明好,虽然不是必须的,但这样可以使代码易读,并且可以方便找出那些没有声明而被编译为全局的变量;

♦ 将每个变量单独放置一行,并加注释,以变量开头字母排序为序,并采用驼峰命名规范,如下:

var   ageValue,           //年龄值

nameValue,       //姓名值

sexValue            //性别

2、函数声明

所有的函数必须在使用前声明;跟在var变量声明后面声明函数,方便查看变量作用域;

具名函数声明:函数名与左括号 “(” 之间不应该有空格,

右括号“(” 与主体语句大括号 “{” 之间应该有空格

       程序主体应当缩进4个空格,而非一个Tab(Tab占位没有一个统一的标准)

       主体语句结束符号 “}” 与函数声明开始哪一行对齐;

       function fun(str) {

           var m=0;

m=m+str;

}

匿名函数声明:函数名与左括号“(”之间应当有空格,便于阅读;

       function (str) {

           str="hello";

}

3、注释

要将注释写出来;良好的代码注释可以给日后的自已或者读者提供理解代码的捷径。

代码注释不要太冗长或带有个人情绪;

代码注释要有意义,不要写一些根本就不需要写的注释;

注释要跟随代码的修改及时更新,避免误导。

原文章引用地址:http://www.2cto.com/kf/201305/213172.html

上一篇:(IOS)数据持久化


下一篇:mongodb基本的配置和使用