使用以下提示编写更具可读性的代码

• 指南
• 注释
  • 添加注释的一般规则。
• 变量
  • 变量声明
  • 变量操作
• 数据比较
• 字符串
• 验证
• 函数
  • 函数的声明和调用
  • 原生语言函数的使用

当程序只由我们编写时，相对容易理解，因为我们**"理解"**自己。

但事实证明，你创建的大多数程序可能都是与其他人一起完成的。即使你是独自完成的，如果其他人能理解不是更好吗？

这就是为什么我为你带来了这个基于JavaScript编程**标准**的指南。

指南

制定本指南的目的是规范开发代码的编写方式。这是为了统一标准，减少分析时间，并促进对以前编写的代码的理解和更新。 本指南包含JavaScript和PHP的示例。

注释

添加注释的一般规则。

JavaScript

// 不要用大写字母开头，也不要用句号'.'结尾

/**
 * 以大写字母开头的多行注释
 * 主要是因为它们通常用于记录大的
 * 代码块，例如函数
 */

/* 在注释斜线之间使用空格 */

let x = 'x'; // 在语句结尾和斜线'//'之间留一个空格

变量

变量声明

在声明变量时，避免将初始值留为null。 在variable =和它的值之间放一个空格。

JavaScript

// 避免使用'var'来声明变量
let string = ''; // 变量初始化为'string'
let number = 0; // 变量初始化为'number' 
let object = {}; // 变量初始化为'object'
let array = []; // 变量初始化为'array'

PHP

$string = '';       // 变量初始化为'string'
$number = 0;        // 变量初始化为'number'
$array = [];        // 变量初始化为'array'

变量操作

在对变量进行操作时，建议在操作符之间留出空格。

JavaScript

let one = 1;
let two = 2;
let three = one + two;
let four = one * 2 + two;

PHP

$one = 1;
$two = 2;
$three = $one + $two;
$four = $one * 2 + $two;

数据比较

建议使用三重比较运算符===而不是==。

这是因为三重比较===检查值和数据类型是否相等。

if ('25' == 25) {
  // 比较成功
}
if ('25' === 25) {
  // 比较失败，因为它将'string'数据类型与'number'进行比较
}

字符串

建议使用单引号''来处理字符串。

let x = 'string';
if (x === 'string') {
  // 条件成立
} else {
  // 条件不成立 
}

验证

如果你想验证你正在处理的变量是否属于特定的数据类型，你可以使用以下验证方法。

JavaScript

// 验证是否为整数类型
let num = 0;
if (typeof num === 'number') {
  // 验证成功
}

// 验证是否为字符串类型
let str = 'hello';
if (typeof str === 'string') {
  // 验证成功
}

// 验证是否为对象
let obj = {};
if (typeof obj === 'object') {
  // 验证成功
}

// 验证是否为数组
let arr = [];
if (Array.isArray(arr)) {
  // 验证成功
}

// 验证是否为布尔值
let bool = true;
if (typeof bool === 'boolean') {
  // 验证成功
}

使用typeof x === 'array'是错误的，因为JavaScript中的数组是对象。

PHP

// 验证是否为整数类型
$num = 0;
if (is_int($num)) {
  // 验证成功
}

// 验证是否为字符串类型
$str = 'hello';
if (is_string($str)) {
  // 验证成功
}

// 验证是否为对象
$obj = {};
if (is_object($obj)) {
  // 验证成功
}

// 验证是否为数组
$arr = [];
if (is_array($arr)) {
  // 验证成功
}

// 验证是否为布尔值  
$bool = [];
if (is_bool($bool)) {
  // 验证成功
}

函数

函数的声明和调用

在声明函数时，应该在关键字function、圆括号()和起始大括号{之间放置一个空格。

这是为了区分函数声明和函数调用。

JavaScript

// 函数的声明
function iAmAFunction() {
  console.log('这是一个文本打印输出');
}

// 在对象中声明函数
let object = {
  iAmAFunction: function () {
    console.log('这是一个文本打印输出');
  },
};

// 调用函数
iAmAFunction();

PHP

// 函数的声明
function iAmAFunction() {
  echo '这是一个文本打印输出';
}

// 调用函数
iAmAFunction();

原生语言函数的使用

如果值是以下之一，JavaScript会认为它是false：

• false
• 0
• '' 或 ""
• null
• undefined
• NaN (例如，0之间的除法)

条件语句 if 和 else

if (condition) {
  // 第一个条件的代码
} else if (anotherCondition) {
  // 第二个条件的代码
} else {
  // 第三个条件的代码
}

// 三元条件
let condition = true(condition) ? '满足条件' : '不满足条件'; // 满足条件

循环 while 和 for

for (let a = 0; a < 10; a++) {
  // 重复代码
}

while (true) {
  // 重复代码
}

do {
  // 重复代码
} while (true);