JS命名规范、引用规范

今天记录使用JS命名规范、引用规范,使用统一的编码规范编写代码能提高JS代码的可读性,利于后期的维护和扩展,利于团队开发。
    JS代码的引用规范
    JS代码应避免内嵌在HTML文件中,而因采用另置为*.JS的文件,然后用<script src="*.JS"></script>载入,原因在于这样做可以利用浏览器的Cache(缓存)避免页面刷新而重新加载,对于JS代码来讲是没有必要的,反而是加大了文件的传输量。这里建议JS代码采用分多个文件置开的方法,好处在于可以减少因JS代码修改引发的重复调用。
   命名规范的原则是:以最少的字母达到最容易理解的意义。
   JS代码的命名规范:
   1、变量声明:
       在开发中,所有的变量必须在使用前声明好,JavaScript里并不一定要这么做,可是建议你这样做,原因是这样做可以让代码变的易读,并且可以很好的找出那些因没有声明而被编译为全局的变量。
       声明变量时将var放在声明的最前部,将每个变量单独成一行,并在其后加以注释,顺序以字母排序。
 
var ageValue,   //用于存诸年龄值
    nameValue, //用于存诸姓名值
    sexValue;    //用于存诸性别值     命名规范引用了C#里的Camel(骆驼命名规范)。
   2、函数的声明:
       所有的函数必须在使用前声明。内函数的声明跟在var的后面,这样可以帮助判断那些变量是在函数范围内的。
       函数名与“(”左括号之间不应该有空格,右括号“)”与语句主体的开始“{”大括号之间要空一格,程序主体因缩进四个空格而不是一个Tab(原因使用Tab目前还没有统一的标准尺度),函数主体结尾的“}”大括号要与函数声明的那一行开头对齐。示例如下:

function createXmlHttp() {
    /// <summary>创建xmlhttp对象</summary>
    if (window.XMLHttpRequest) {
        return new XMLHttpRequest();
    } else if (window.ActiveXObject) {
        return new ActiveXObject("msxml2.xmlHttp");
    }
}
     如果函数是匿名函数,那么在function和“(”左括号之间因有一个空格,不然容易让代码读者误认为是声明了一个名为function的函数。

//给String扩展一个清空字符的方法
String.prototype.trim = function (str) {
    var reg = / \t/ig;
    //return reg.replace(str,"");
    return str.replace(reg, "");
}在编写JS中尽量不要使用全局函数。
    3、注释
         说到最后还是要把代码注释讲出来,编码的过程中不要吝啬注释,良好的代码注释可以给日后的自已或者读者提供理解代码的捷径。同时在写注释的时候不要过于冗长或者带有个人的情绪代在里面。另外对于注释的及时更新也很重要,因为一段错误的代码注释不仅不能为自已或读者提供理解代码的捷径,反而会带入误区。最后就是在注释要写的有意义,不要让日后的自已或读者将宝贵的时间浪费在如下示例上。

int index ++;//这里的index每次加一

  • 0
    点赞
  • 0
    评论
  • 0
    收藏
  • 一键三连
    一键三连
  • 扫一扫,分享海报

©️2021 CSDN 皮肤主题: 大白 设计师:CSDN官方博客 返回首页
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、C币套餐、付费专栏及课程。

余额充值