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

クリーンなコードのいくつかの原則の 1 つは、あいまいさを避け、よりクリーンなコードを作成するために、変數(shù)に自己記述的かつ自明の名前を付けることです。偉大な作家であるゼノ ロシャ氏は、著書 生産性を高める 14 の習(xí)慣の中でこう述べています。開発者 私たちは常に、何年経っても未來の自分が理解できるコードを書く必要があります。変數(shù)に小文字や略語を付けると、特にプロジェクトへの関與レベルが異なる開発者間で異なる解釈が生じる可能性があり、將來的に問題が発生する可能性があります。

コード ベースが大きくなり、その変數(shù)が脇に殘されると、將來それを再検討する必要が生じ、書き方が不十分だと役立つコードを理解することが難しくなるのはよくあることです。

悪い変數(shù)の例:

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

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

良い変數(shù)の例:

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 

意味のある変數(shù)名を記述するという同じロジックの中で、別の重要なポイントに到達(dá)します。それは、同じ記述方向に従うブール変數(shù)を記述する場合ですが、前のルールに累積する別の小さなルールを使用する必要があります。

彼女は次のように言います。ブール変數(shù)は、「はい」または「いいえ」で答えられる質(zhì)問であるかのように書く必要があります。これは、ブール変數(shù)は true (yes) または false (no) と質(zhì)問のみを受け取ることができるためです。アクティブかどうかを判斷することは、コードを読むのに役立ちます。

ルールを適用しない例:

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

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

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

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

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

このコードの意味がわかりますか?

このような言葉では言い表せない數(shù)字があると難しいですよね?

「コードを削除するとコードが壊れる理由がわかりません」というフレーズを聞いたことがありますか?これは私がここで言いたいことをよく表しています。これらの數(shù)値を放置せず、その數(shù)値が存在する理由を説明せずに、変數(shù)で明確にできない場合は、コードに簡単なコメントを作成してください。

このコードがどのように記述されるべきかを見てください。

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

もう良くなりましたね?

利點(diǎn)

変數(shù)に明確な名前を付ける、マジック ナンバーを回避する、クリーン コードの原則に従うなどのプラクティスを採用すると、コードの品質(zhì)が向上するだけでなく、他の開発者との共同作業(yè)や長期的な保守が容易になります。

覚えておいてください: クリーンなコードを書くということは、完璧を達(dá)成することではなく、コードをよりアクセスしやすく、理解しやすく、將來のあなたも含めた使用者全員にとって予測可能にすることです。

これらのルールを次のプロジェクトに適用してみて、違いに注目してください。これらのヒントを同僚やチームと共有して、より生産的で効率的な作業(yè)環(huán)境を構(gòu)築してください。結(jié)局のところ、適切に記述されたコードは、高品質(zhì)のソフトウェアを構(gòu)築するための第一歩です。

それでは、今日から始めてみませんか？將來読んで誇りに思えるコードを書いてください!

以上がクリーンなコードに基づいた変數(shù)の命名の詳細(xì)內(nèi)容です。詳細(xì)については、PHP 中國語 Web サイトの他の関連記事を參照してください。