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 name with camelCase
      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');
   // single line statement
   const arr = ["one", "two", "Three"];

   // Compound statement
   for (let i = 0; i < arr.length; i++) {
      output.innerHTML += arr[i] + "<br>";
   }

   // Multi-line statement
   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>

在本教程中，我们解释了常见的样式约定。但是，您可以拥有自己的编码约定，并在整个项目中遵循它们。

打印页面