可读性和 IF 块括号：最佳实践

Question

我正在为学习 JavaScript 基础知识的 1 级大学学生准备一个简短的教程。任务是验证电话号码。该号码不得包含非数字，且长度不得超过 14 位数字。以下代码摘录是我想出的，我希望使其尽可能具有可读性。

if (
    //set of rules for invalid phone number
        phoneNumber.length == 0 //empty
    ||  phoneNumber.length > 14 //too long
    ||  /\D/.test(phoneNumber) //contains non-digits
) {
    setMessageText(invalid);
} else {
    setMessageText(valid);
}

一个简单的问题我自己无法回答，想听听您的意见：如何定位周围（最外面的）括号？很难看出普通括号和大括号之间的区别。您通常是否将最后一个 ) 与最后一个条件放在同一行？您是否将第一个开头 ( 单独放在一行上？您是否也将每个单独的子条件括在括号中？您是否将第一个 ( 与最后一个 < 水平对齐code>)，还是将最后一个 ) 与 if 放在同一列中？

是将 ) { 保留在单独的行上，还是将最后一个 ) 与最后一个子条件放在同一行，然后将开头的 {换行？或者您只是将 ) { 与最后一个子条件放在同一行？

社区维基。

编辑 请仅发表有关括号的使用和放置的意见。代码不需要重构。这适用于几周前才接触 JavaScript 的人。我并不是在询问如何编写代码以使其更短或性能更好的意见。我只想知道如何在 IF 条件周围放置括号。

Answer 1

我会将验证电话号码的逻辑重构为函数：

function isValidPhoneNumber(phone) {
  if (phone.length == 0) return false;
  if (phone.length > 14) return false;
  return !/\D/.test(phone);
}

或者您也可以使用正则表达式来检查长度：

function isValidPhoneNumber(phone) {
  return /^\d{1,14}$/.test(phone);
}

使用验证电话号码的函数，代码会变得更简单：

if (isValidPhoneNumber(phoneNumber)) {
  setMessageText(valid);
} else {
  setMessageText(invalid);
}

甚至：

setMessageText(isValidPhoneNumber(phoneNumber) ? valid : invalid);

Answer 2

tuh-MAY-toe

toe-MAH-tuh

除非有奇怪的习惯，“可读”是你习惯看到的

我会这样格式化你的示例：

//set of rules for invalid phone number:
//    - not empty
//    - not too long (14 characters)
//    - can contain only digits
if (phoneNumber.length == 0 ||
    phoneNumber.length > 14 ||
    /\D/.test(phoneNumber))
{ 
    setMessageText(invalid); 
}
else 
{ 
    setMessageText(valid); 
} 

因为我更喜欢看到一起解释的逻辑而不是散布在代码语句中。我喜欢将大括号单独放在一条线上，以使块更好地突出。

但是 - 正如其他人指出的 - 为了这个示例的“最终”可读性，它应该至少重构为一个 isValidPhoneNumber 函数

Answer 3

message = invalid
if(phoneNumber.length > 0 && phoneNumber < 14 && /\D/.test(phonenumber)){
  message = valid
}
setMessageText(message)

本质上，在证明有效之前无效更安全，但这完全是主观的。

在 javascript 中，also:

if(...){
}

总是比: 更好

if(...)
{

}

- 这是因为分号插入，这在这里可能不是问题，但在其他情况下可能会出现问题，因此在使用该语言时最好保持相同的习惯。

最后，我不会用比我必须的更多的括号来重载代码，特别是当事情都是“ANDed”时 - 当存在混合运算符优先级时，包含额外的括号很重要，因为不是每个人都会想要考虑阅读代码时。

但这有点主观。对不起。