良いコードと悪いコード:良いコードを書くことが重要な理由とその方法

任意の言語でコードを作成する場合、優れたコーディングプラクティスがありますが、本当に悪いコーディングプラクティスもあります。

コンパイルと実行のタイミングに関しては、どちらも正しい場合があります。しかし、不適切なコードは、開発、デバッグ、および変更においていくつかの問題を引き起こす可能性があります。職場では、プログラムがどれだけうまく実行されても、誰かがコードを読んだり変更したりする必要があります。

新しい機能を追加したり、まれにしか発生しないバグを修正したり、機能を理解するためだけに読みたい場合があります。同様に、同じことを行うには他の人のコードを読む必要があります。コードが読みやすく、理解できれば、誰もがずっとうまくいくでしょう。

質の高いコードの重要性を知るために、質の悪いコードが何につながるかを理解してみましょう。不適切に記述されたコードは、ソフトウェアのさらなるメンテナンス、拡張、または調整に必要な金銭的損失または時間の浪費につながる可能性があります。

コードを1回書いた後、何度もそれに従います。したがって、コードの文書化は非常に重要になり、命名規則は非常に重要になります。

多くの場合、同僚が数日前に書いたコードやロジックを覚えていないことについて冗談を言っています。悪いコードスタイルを記述することと組み合わせると、何をしたかを理解するのに時間がかかります。アーティストが自分の作品を理解できなかったとき、物事は混乱し始めますstart

コードを記述する際に留意すべきキーポイント

//救助者へのコメント

ほとんどの現代言語には、文書化された宣言型コメントがあり、単一行および複数行のコメントと組み合わせて使用​​すると、コードがより理解しやすくなり、保守が容易になります。

良いコードのコメントは、何が行われたかではなく、何が行われたかを説明しています。コード自体が実行内容を説明しています。コメントの必要性は最小限に抑える必要があります。

くぼみ

良いコードは、図に示すように適切に構成されています。コードのブロックの開始位置と終了位置を理解しようとする人にとっては明らかなはずです。そのため、コードベースのロジックに従うことは明白で簡単です。

インデント:通常のノルム4スペースインデント

Readme's

プロジェクトのコードベースを目の前に置いていると面倒ですが、セットアップと最初の実行には時間がかかります。これは、readmeが役立つ場所です。

コードにアクセスする前に、プロジェクトの簡単なイントロを用意することをお勧めします。適切に構造化されたReadmeがまさにそれを行います。適切に構成されたReadmeは次のようになります。

命名規則

多くの場合、Apimanagerという名前のクラスに出会いますが、名前を見ると、クラスの目的は明確ではありません。

最高のコーディング慣行に従って、クラスは単一責任原則(SRP)に従う必要があります。適切な命名規則とSRPを組み合わせることで、プロジェクトを追おうとするときの生活がずっと楽になります。

クラスが集中的な作業単位を実行している場合、命名規則もスコープごとに異なる必要があります。これは、コードのブロックを見るだけで変数がスコープ外になるタイミングと場所を区別するためです。

最も一時的なオブジェクトを除くすべてに対して、意味のある命名規則を使用します。何かの名前は、オブジェクトをいつどのように使用するかについて有益です。

マジックナンバーを避ける

マジックナンバーとは何ですか?これは定数であり、完全に文書化されていませんが、プログラムが正しく機能するためには特定の値でなければなりません。その番号が選ばれた理由は誰にもわかりません。

最も魔法のように、その数字がプログラムにどのように影響するかを誰も本当に知りません…それを変えることは物事を壊すことを除いて。

マジックナンバーは悪であり、すぐに廃止されるべきです。

時間枠への調整

下の写真はそれ自体を物語っています。

期限までのコード品質

クリーンで高品質のコードを記述するための一般的なプラクティス

コード品質を改善するために広く使用されている手順

良質のコードを書くことは動的なプロセスです。 「適切なコード」を作成する際に考慮すべき点がいくつかあります。

  • 良いコードはよく組織されています。クラスのデータと操作は一致します。クラス間に無関係な依存関係はありません。 「スパゲッティ」のようには見えません。
  • 良いコードは十分にテストされています。テストは、コードとその使用例の実行可能な仕様として機能します。
  • 良いコードは「巧妙」ではありません。それは単純明快な方法で物事を行います。
  • 優れたコードは、小さくて読みやすい計算単位で開発されます。これらのユニットはコード全体で再利用されます。

読んでくれてありがとう、あなたがそれが有用であるとわかったならば、それを共有してください:)