基于干净代码的变量命名

干净代码是一组几种代码约定，它们共同创建了一种编写代码的新方式，使其更具可读性、可维护性、可靠性和可预测性，从而提高效率并促进团队合作.

干净代码的几个原则之一是使用自描述和不言自明的名称来命名变量，以避免歧义并编写更干净的代码，一位伟大的作家 Zeno Rocha 在他的书中说道 高生产力的 14 个习惯开发人员 我们应该始终编写未来的自己即使在多年后也能理解的代码。使用缩写或缩写命名变量可能会导致不同的解释，特别是在项目参与程度不同的开发人员之间，这可能会导致未来的问题。

很常见的是，随着代码库的增长并且其变量被搁置，将来需要重新访问它，而糟糕的编写将导致难以理解您的代码。

不良变量的示例：

const date = new Date()
// Nome da varável é muito genêrica e não explica o que ela é

function getData(req, res) {}
// Nâo descreve bem o dado que ela está requisitando 

好的变量的例子：

const currentDate = new Date()
// Nome mais explicativo sobre o que ela é e menos genêrico

function getUserGithubCategory(req, res) {} 
// Descreve melhor o dado que a função está requisitando 

仍然按照编写有意义的变量名称的相同逻辑，我们遇到了另一个重要的点，即在编写遵循相同编写方向的布尔变量时，但我们必须使用另一个累积到前一个的小规则。

她说如下，我们应该把布尔变量写成某种可以回答是或否的问题，这是因为布尔变量只能接收 true (是) 或 false (否) 和一个问题说出它们是否活跃有助于代码阅读。

不应用规则的示例：

const ticketPark = user.ticketPark 

if (!ticketPark ) {
  throw new Error('O Marcos não possui um bilhete para entrar no parque!')
}

应用规则的示例：

const hasUserTicket = user.hasTicket // o usuário tem o ticket ?

if (!hasUserTicket) { // se o usuário não tiver o ticket 
  throw new Error('O Marcos não possui um bilhete para entrar no parque!')
}

你是否同意我的观点，当使用这种命名布尔变量的模型时，如果用户有票，他可以去乘车，而不是仅仅检查公园票是否没有，这并不会让阅读变得更简单伪造的？ 使用这些类型确实可以提高第三方对您的代码的理解，并帮助您避免歧义。

最后，我们还有一个与最后两条规则相关的更简单的规则，除了更好地编写代码之外，还可以使用变量在代码中存储“幻数”。但毕竟，代码中的这些神奇数字是什么？ 通常，许多程序员在将业务规则应用到他们的项目时，会使用各种数字来执行代码中的某些操作，然后将这些操作扔到代码中，而不必解释它们为什么在那里。

充满幻数的代码示例：

const date = new Date()
// Nome da varável é muito genêrica e não explica o que ela é

你能明白代码的用途吗？

这些难以形容的数字很难吧？

你有没有听过这句话“我不知道为什么如果你删除代码会破坏”？它很好地表达了我在这里想说的，避免让这些数字松散并且没有解释它们为什么在那里，如果不可能在变量中明确说明，请在代码中进行简单的注释。

看看这段代码应该怎么写：

function getData(req, res) {}
// Nâo descreve bem o dado que ela está requisitando 

现在好多了，对吧？

好处

采用清晰命名变量、避免幻数以及遵循干净代码原则等做法不仅可以提高代码质量，而且还可以更轻松地与其他开发人员协作并进行长期维护。

请记住：编写干净的代码并不是为了达到完美，而是为了让代码对每个使用它的人（包括将来的您）更易于访问、理解和预测。

尝试将这些规则应用到您的下一个项目中并注意其中的差异！与同事或您的团队分享这些技巧，以创建一个更加高效的工作环境。毕竟，编写良好的代码是构建高质量软件的第一步。

那么，从今天开始怎么样？编写您将来会自豪地阅读的代码！

以上是基于干净代码的变量命名的详细内容。更多信息请关注PHP中文网其他相关文章！