欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  web前端

JavaScript编写可维护的代码

程序员文章站 2022-03-29 22:14:18
...

基本的格式化缩进层级4个空格缩进,最好统一tab为4个字符。语句结尾结尾分号产生错误的例子。

//原始代码function getData() {    return     {        title:"Maintainable JavaScript",        author:"Nicholas C. Zakas"    }
//分析器会它理解function getData

基本的格式化

缩进层级

4个空格缩进,最好统一tab为4个字符。

语句结尾

结尾分号

产生错误的例子

//原始代码function getData() {
    return 
    {
        title:"Maintainable JavaScript",
        author:"Nicholas C. Zakas"
    }//分析器会它理解function getData() {
    return;
    {
        title:"Maintainable JavaScript",
        author:"Nicholas C. Zakas"
    };
}

可以通过将左花括号移至与return同一行的位置来修复这个问题。

//这段代码工作正常,尽管没有用分号function getData() {
    return {
        title:"Maintainable JavaScript",
        author:"Nicholas C. Zakas
    }
}

行的长度

80个字符
换行
通常我们会在运算符后换行,下一行会增加两个层级的缩进(8个字符)

例外:当给变量赋值时,第二行的位置应当和赋值运算符的位置保持对齐,例如

var result = something + antherThing + yetAnotherThing + somethingElse + 
             anotherSomethingElse;

空行

  • 在方法之间

  • 在方法的局部和语句之间

  • 在多行或单行注释之前

  • 在方法内的逻辑片段之间插入空行,提高可读性

基本的格式化

缩进层级

4个空格缩进,最好统一tab为4个字符。

语句结尾

结尾分号

产生错误的例子

//原始代码function getData() {
    return 
    {
        title:"Maintainable JavaScript",
        author:"Nicholas C. Zakas"
    }//分析器会它理解function getData() {
    return;
    {
        title:"Maintainable JavaScript",
        author:"Nicholas C. Zakas"
    };
}

可以通过将左花括号移至与return同一行的位置来修复这个问题。

//这段代码工作正常,尽管没有用分号function getData() {
    return {
        title:"Maintainable JavaScript",
        author:"Nicholas C. Zakas
    }
}

行的长度

80个字符
换行
通常我们会在运算符后换行,下一行会增加两个层级的缩进(8个字符)

例外:当给变量赋值时,第二行的位置应当和赋值运算符的位置保持对齐,例如

var result = something + antherThing + yetAnotherThing + somethingElse + 
             anotherSomethingElse;

空行

  • 在方法之间

  • 在方法的局部和语句之间

  • 在多行或单行注释之前

  • 在方法内的逻辑片段之间插入空行,提高可读性

以上内容就是JavaScript编写可维护的代码,希望能帮助到大家。

相关推荐:

JavaScript编写一个简易的AJAX方法库教程

常见的JavaScript内存泄露

JavaScript中split函数由浅到深的使用介绍

以上就是JavaScript编写可维护的代码的详细内容,更多请关注其它相关文章!