首页 web前端 js教程 基于干净代码的变量命名

基于干净代码的变量命名

Dec 28, 2024 am 12:49 AM

Nomeação de variáveis baseada no clean code

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

干净代码的几个原则之一是使用自描述和不言自明的名称来命名变量,以避免歧义并编写更干净的代码,一位伟大的作家 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中文网其他相关文章!

本站声明
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热AI工具

Undresser.AI Undress

Undresser.AI Undress

人工智能驱动的应用程序,用于创建逼真的裸体照片

AI Clothes Remover

AI Clothes Remover

用于从照片中去除衣服的在线人工智能工具。

Undress AI Tool

Undress AI Tool

免费脱衣服图片

Clothoff.io

Clothoff.io

AI脱衣机

Video Face Swap

Video Face Swap

使用我们完全免费的人工智能换脸工具轻松在任何视频中换脸!

热工具

记事本++7.3.1

记事本++7.3.1

好用且免费的代码编辑器

SublimeText3汉化版

SublimeText3汉化版

中文版,非常好用

禅工作室 13.0.1

禅工作室 13.0.1

功能强大的PHP集成开发环境

Dreamweaver CS6

Dreamweaver CS6

视觉化网页开发工具

SublimeText3 Mac版

SublimeText3 Mac版

神级代码编辑软件(SublimeText3)

前端热敏纸小票打印遇到乱码问题怎么办? 前端热敏纸小票打印遇到乱码问题怎么办? Apr 04, 2025 pm 02:42 PM

前端热敏纸小票打印的常见问题与解决方案在前端开发中,小票打印是一个常见的需求。然而,很多开发者在实...

神秘的JavaScript:它的作用以及为什么重要 神秘的JavaScript:它的作用以及为什么重要 Apr 09, 2025 am 12:07 AM

JavaScript是现代Web开发的基石,它的主要功能包括事件驱动编程、动态内容生成和异步编程。1)事件驱动编程允许网页根据用户操作动态变化。2)动态内容生成使得页面内容可以根据条件调整。3)异步编程确保用户界面不被阻塞。JavaScript广泛应用于网页交互、单页面应用和服务器端开发,极大地提升了用户体验和跨平台开发的灵活性。

谁得到更多的Python或JavaScript? 谁得到更多的Python或JavaScript? Apr 04, 2025 am 12:09 AM

Python和JavaScript开发者的薪资没有绝对的高低,具体取决于技能和行业需求。1.Python在数据科学和机器学习领域可能薪资更高。2.JavaScript在前端和全栈开发中需求大,薪资也可观。3.影响因素包括经验、地理位置、公司规模和特定技能。

JavaScript难以学习吗? JavaScript难以学习吗? Apr 03, 2025 am 12:20 AM

学习JavaScript不难,但有挑战。1)理解基础概念如变量、数据类型、函数等。2)掌握异步编程,通过事件循环实现。3)使用DOM操作和Promise处理异步请求。4)避免常见错误,使用调试技巧。5)优化性能,遵循最佳实践。

如何使用JavaScript将具有相同ID的数组元素合并到一个对象中? 如何使用JavaScript将具有相同ID的数组元素合并到一个对象中? Apr 04, 2025 pm 05:09 PM

如何在JavaScript中将具有相同ID的数组元素合并到一个对象中?在处理数据时,我们常常会遇到需要将具有相同ID�...

如何实现视差滚动和元素动画效果,像资生堂官网那样?
或者:
怎样才能像资生堂官网一样,实现页面滚动伴随的动画效果? 如何实现视差滚动和元素动画效果,像资生堂官网那样? 或者: 怎样才能像资生堂官网一样,实现页面滚动伴随的动画效果? Apr 04, 2025 pm 05:36 PM

实现视差滚动和元素动画效果的探讨本文将探讨如何实现类似资生堂官网(https://www.shiseido.co.jp/sb/wonderland/)中�...

JavaScript的演变:当前的趋势和未来前景 JavaScript的演变:当前的趋势和未来前景 Apr 10, 2025 am 09:33 AM

JavaScript的最新趋势包括TypeScript的崛起、现代框架和库的流行以及WebAssembly的应用。未来前景涵盖更强大的类型系统、服务器端JavaScript的发展、人工智能和机器学习的扩展以及物联网和边缘计算的潜力。

console.log输出结果差异:两次调用为何不同? console.log输出结果差异:两次调用为何不同? Apr 04, 2025 pm 05:12 PM

深入探讨console.log输出差异的根源本文将分析一段代码中console.log函数输出结果的差异,并解释其背后的原因。�...

See all articles