概述

我相信理解好的编程概念会提高程序员的水平。
好的概念不依赖于特定的编程语言,并且在许多不同的编程语言中都很有用。
上次介绍了不做的原因(早退)。
这次要介绍的一个好概念是“好代码来自好名字”。

好名字造就好代码

在编程中,您必须为变量、函数、类等命名。
代码可读性对于人类理解代码非常重要。
一个有意义的名称使您的代码更具可读性。

示例代码

根据您的命名方式,代码的外观是否有所不同?
将具有无意义名称的代码与具有有意义名称的代码进行比较。

1. 给你的变量名起个好名字

这是一个计算产品含税金额的示例代码。

bad_variable_name.js
// a: 消費税率, b: 金額, c: 消費税, d: 税込金額
const a = 0.1
let b = 1000;
let c = b * a;
let d = b + c;

没有注释,很难理解代码在做什么。
让我们给变量名一些有意义的东西。

good_variable_name.js
const TaxRate = 0.1;
let price = 1000;
let tax = price * TaxRate;
let total = price + tax;

该过程完全相同,但更易于阅读。
通过为变量赋予有意义的名称,您可以快速了解代码在做什么。

2.给你的函数名起个好听的名字

这是一个定义和执行函数的示例代码。

bad_function_name.js
function funcA() {
    // チェック処理
}

function funcB() {
    // 計算処理
}

function funcC() {
    // ログ出力処理
}

// チェック処理、計算処理、ログ出力処理の順番で実行
funcA();
funcB();
funcC();

没有评论,我不知道你在做什么。
让我们给函数起一个有意义的名字。

good_function_name.js
function check() {
    // チェック処理
}

function calculate() {
    // 計算処理
}

function outputLog() {
    // ログ出力処理
}

check();
calclate();
outputLog();

你可以从函数名中预测会进行什么样的处理(当然要描述与函数名匹配的处理)。

3. 给你的条件取个好名字

给条件表达式命名可能听起来不熟悉,但它是有效的。

bad_condition_name.js
const TargetTotalPrice = 1000000;
const TargetVisitCount = 20;

// ゴールド会員の判定をします(一定金額以上の利用かつ一定回数の来店でゴールド会員)
if (totalPrice >= TargetTotalPrice && visitCount >= TargetVisitCount)
{
    // ゴールド会員の処理をします
}

代码很好,但我发现在 if 语句中阅读起来有点困难。
让我们给条件一个有意义的名字。

good_condition_name.js
const TargetTotalPrice = 1000000;
const TargetVisitCount = 20;
const isGoldMember = totalPrice >= TargetTotalPrice && visitCount >= TargetVisitCount;

if (isGoldMember) {
    // ゴールド会員の処理をします
}

我刚刚给变量赋值了一个条件表达式,但是你不觉得给它起个名字更容易看吗?
此外,通过成为变量,可以在相同条件的情况下重复使用该变量。

4.给你的班级起个好听的名字

这是类名的示例代码(Python)。
名称很重要,因为类封装了数据结构(变量)和行为(函数)。

B d_c s_ 舔。 py
class Class1:
    def say(self):
        return "hello!"

class Class2(Class1):
    def say(self):
        return "こんにちは!"

由于没有写评论,我不认为你可以从类名中读取你想要做什么。
让我们给这个类起一个有意义的名字。

去 d_c s_ 舔。 py
class Greeting:
    def say(self):
        return "hello!"

class JapaneseGreeting(Greeting):
    def say(self):
        return "こんにちは!"

如果是与问候有关的类,则可以从类名中读取。

概括

这次我介绍的好代码是从好名字中诞生的。
如果您发现代码难以理解,则代码中的名称可能不好。
希望你能明白,好代码源于好名字,感觉自己作为程序员的水平提高了。

感谢您阅读到最后。


原创声明:本文系作者授权爱码网发表,未经许可,不得转载;

原文地址:https://www.likecs.com/show-308632391.html

相关文章: