当前位置：首页 > 文章列表 > 文章 > 前端 > 基于干净代码的变量命名

基于干净代码的变量命名

来源：dev.to 2024-12-30 10:49:05 0浏览收藏

推广推荐

支持 PC / 移动端，安全直达

文章小白一枚，正在不断学习积累知识，现将学习到的知识记录一下，也是将我的所得分享给大家！而今天这篇文章《基于干净代码的变量命名》带大家来了解一下##content_title##，希望对大家的知识积累有所帮助，从而弥补自己的不足，助力实战开发！

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

干净代码的几个原则之一是使用自描述和不言自明的名称来命名变量，以避免歧义并编写更干净的代码，一位伟大的作家 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!')
}

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

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

充满幻数的代码示例：

function calculateshippingcost(distance: number, weight: number): number {
    if (distance < 100) {
        return weight * 5; 
    } else if (distance < 500) {
        return weight * 10; 
    } else {
        return weight * 15; 
    }
}

const cost = calculateshippingcost(250, 20);
console.log(`custo do frete: $${cost}`);

你能明白代码的用途吗？

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

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

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

// Constantes para faixas de distância
const SHORT_DISTANCE_THRESHOLD = 100;
const MEDIUM_DISTANCE_THRESHOLD = 500;

// Constantes para taxas de frete
const SHORT_DISTANCE_RATE = 5;  // $5 por kg
const MEDIUM_DISTANCE_RATE = 10; // $10 por kg
const LONG_DISTANCE_RATE = 15;  // $15 por kg

function calculateShippingCost(distance: number, weight: number): number {
    if (distance < SHORT_DISTANCE_THRESHOLD) {
        return weight * SHORT_DISTANCE_RATE;
    } else if (distance < MEDIUM_DISTANCE_THRESHOLD) {
        return weight * MEDIUM_DISTANCE_RATE;
    } else {
        return weight * LONG_DISTANCE_RATE;
    }
}

const cost = calculateShippingCost(250, 20);
console.log(`Custo do frete: $${cost}`);