JavaScript编码规范

Posted 键盘tops舞者

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了JavaScript编码规范相关的知识,希望对你有一定的参考价值。

原文链接: https://github.com/fex-team/styleguide/blob/master/javascript.md

1 前言

JavaScript在百度一直有着广泛的应用,特别是在浏览器端的行为管理。本文档的目标是使javascript代码风格保持一致,容易被理解和被维护。

虽然本文档是针对JavaScript设计的,但是在使用各种JavaScript的预编译语言时(如TypeScript等)时,适用的部分也应尽量遵循本文档的约定。

2 代码风格

2.1 文件

[建议] JavaScript 文件使用无 BOM 的 UTF-8 编码。

解释:

UTF-8 编码具有更广泛的适应性。BOM 在使用程序或工具处理文件时可能造成不必要的干扰。

[建议] 在文件结尾处,保留一个空行。

2.2 结构

2.2.1 缩进

[强制] 使用 4 个空格做为一个缩进层级,不允许使用 2 个空格 或 tab 字符。
[强制] switch 下的 case 和 default 必须增加一个缩进层级。

示例:

// good
switch (variable) {

    case '1':
        // do...
        break;

    case '2':
        // do...
        break;

    default:
        // do...

}

// bad
switch (variable) {

case '1':
    // do...
    break;

case '2':
    // do...
    break;

default:
    // do...

}

以上是关于JavaScript编码规范的主要内容,如果未能解决你的问题,请参考以下文章

Javascript编码规范,好的代码从书写规范开始,增强代码的可读性,可维护性,这是相当重要的!

递进迭代敏捷

Javascript编码规范

JavaScript编码规范

JavaScript编码规范

JavaScript编码规范