JavaScript - 代码风格指南

JavaScript 代码风格指南是一套规范 JavaScript 代码编写的通用规则。这些规则包括:使用引号、缩进空格数、最大行长、使用单行注释、使用 // 标记等等。

任何公司开始开发实时 JavaScript 项目时，都会有数百名开发人员参与其中。如果每个开发人员都遵循不同的代码编写风格，管理复杂的代码就会变得非常困难。因此，在整个项目中遵循相同的代码风格至关重要。

本文介绍了开发项目时需要遵循的一些基本编码规范。

代码缩进

您应该始终根据项目的编码规范，使用固定的空格(2、3 或 4 个空格)来编写代码。此外，代码尾部不应包含空格。

示例

在下面的代码中，我们在函数中使用了三个空格的缩进。

<html>
   <body>
      <h2> Intendation Conventions </h2>
      <div id = "output"> </div>
      <script>
         const output = document.getElementById('output');
         function func() {
            output.innerHTML = "Function executed!";
            return 10;
         }
         func();
      </script>
   </body>
</html>

注释

您应该始终使用行注释而不是块注释，并且行注释应从代码的左侧部分开始。

示例

在下面的代码中，我们使用 // 行注释来注释代码。

<html>
<body>
   <h2> Comment Conventions </h2>
   <div id="output"> </div>
   <script>
      const output = document.getElementById('output');
      output.innerHTML = "Hello World!";
      // var a = 10;
      // var b = 20;
   </script>
</body>
</html>

变量声明

始终在变量作用域的顶部声明变量。如果变量是全局变量，则在文件顶部声明。同样，如果变量位于块或函数中，则在块或函数的顶部声明。此外，变量名必须以字母开头。

示例

在下面的代码中，我们在代码顶部声明了变量，并且每个变量的名称都以字母开头。

<html>
<body>
   <h2> Variable Conventions </h2>
   <div id="output"> </div>
   <script>
      var a = 10;
      var b = 20;
      document.getElementById('output').innerHTML = 
		"The sum of 10 and 20 is: " + (a + b);
   </script>
</body>
</html>

驼峰式标识符命名

在 JavaScript 中，始终使用驼峰式命名约定来定义标识符。在驼峰式命名约定中，标识符的首字母应小写，第二个单词的首字母应大写。此处的标识符包括函数名、变量名、对象名、类名等。

示例

在下面的代码中，"greetMessage"和"executeGreet"这两个标识符均采用驼峰式命名。

<html>
<body>
   <h2> camelCase Conventions </h2>
   <div id="output"> </div>
   <script>
      var greetMessage = "Hello Developers!";
      let output = document.getElementById('output');
      // 函数名称采用驼峰命名法
      function executeGreet() {
         output.innerHTML = greetMessage;
      }
      executeGreet();
   </script>
</body>
</html>

空格和括号

在 JavaScript 中，我们应该在每个运算符(例如 +、typeof 等)前后添加空格。此外，在括号周围添加空格也至关重要。

示例

在下面的代码中，我们在 if 条件后添加了适当的空格。此外，我们在 += 运算符前后也添加了空格。

<html>
<body>
   <h2> Space and all brackets Conventions </h2>
   <div id="output"> </div>
   <script>
      let output = document.getElementById('output');
      if (9 > 10) {
         output.innerHTML += "9 is greater than 10";
      } else {
         output.innerHTML += "9 is not greater than 10";
      }
   </script>
</body>
</html>

对象规则

在 JavaScript 中，我们在对象标识符后使用赋值运算符 = 和左括号 {。接下来，我们编写对象属性(用分号分隔的键值对)，并将每个属性写在新行中，并用逗号 (,) 分隔。此外，我们不在最后一个对象属性后添加逗号。最后，我们在添加右括号后添加分号 (;)。

示例

在下面的代码中，我们根据对象准则定义了对象。此外，我们使用 JSON.stringify() 方法在网页上显示对象。

<html>
<body>
   <h2> Object Conventions </h2>
   <div id="output"> </div>
   <script>
      const obj = {
         prop1: 'value1',
         prop2: 'value2',
         prop3: 'value3'
      };
      document.getElementById("output").innerHTML = JSON.stringify(obj, null, 2);
</script>
</body>
</html>

语句规则

JavaScript 中有三种类型的语句。

• 简单的单行语句

• 复合语句

• 多行语句

简单的单行语句应始终以分号结尾。

对于复合语句，我们在同一行的语句后放置空格和一个左括号。接下来，我们从下一行开始添加语句主体，并在最后一行添加一个右括号。右括号后不加分号。

如果语句太长，无法在一行中写完，我们可以在运算符后添加换行符。

示例

在下面的代码中，我们定义了单行、复合和多行语句。

<html>
<body>
<h2> Statement Guidelines Conventions </h2>
<div id="output"> </div>
<script>
   const output = document.getElementById('output');
   // 单行语句
   const arr = ["one", "two", "Three"];

   // 复合语句
   for (let i = 0; i < arr.length; i++) {
      output.innerHTML += arr[i] + "<br>";
   }

   // 多行语句
   if (10 > 9 && 10 > 5 && 10 > 6) {
      output.innerHTML += "10 is greater than 9 and 10 is greater than 5 <br>";
   }
</script>
</body>
</html>

代码行长

长代码行总是难以阅读。因此，一行最多只能包含 80 个字符。

示例

在下面的代码中，由于字符串长度超过 80 个字符，我们另起一行添加了半个字符串。

<html>
<body>
   <h2> Line length Conventions </h2>
   <div id="output"> </div>
   <script>
      let str = `This is too long a sentence. 
            Let's put the limit of 80 characters.`
      document.getElementById('output').innerHTML = str;
   </script>
</body>
</html>

本教程已讲解了常见的样式约定。不过，您也可以创建自己的编码约定，并在整个项目中遵循这些约定。