クリーンなコードに基づいた変数の命名

クリーン コードは、コードをより読みやすく、保守しやすく、信頼性と予測可能にし、効率を促進し、チームワークを促進する新しい方法を一緒に作成するいくつかのコード規則のセットです。 .

クリーンなコードのいくつかの原則の 1 つは、あいまいさを避け、よりクリーンなコードを作成するために、変数に自己記述的かつ自明の名前を付けることです。偉大な作家であるゼノ ロシャ氏は、著書 生産性を高める 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 (yes) または false (no) と質問のみを受け取ることができるためです。アクティブかどうかを判断することは、コードを読むのに役立ちます。

ルールを適用しない例:

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!')
}

ブール変数に名前を付けるこのモデルを使用する場合、ユーザーがパークチケットを持っていないことを確認するだけでなく、チケットを持っていれば乗り物に行くことができるということで、読み取りが簡単になるわけではないという意見に同意しますか?偽物？ これらのタイプを使用すると、サードパーティによるコードの理解が大幅に向上し、曖昧さの回避にも役立ちます。

最後に、最後の 2 つに付随する単純なルールが 1 つだけあります。これは、コードをより適切に記述することに加えて、変数を使用してコード内に「マジック ナンバー」を格納することです。しかし、結局のところ、コード内のこれらの魔法の数字は何でしょうか? 一般に、多くのプログラマーは、ビジネス ルールをプロジェクトに適用するときに、さまざまな数値を使用してコード内でいくつかの操作を実行しますが、それらの数値が、なぜそこにあるのかについて必ずしも説明されずにコードに投入されます。

マジックナンバーが詰まったコードの例:

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 中国語 Web サイトの他の関連記事を参照してください。