ソフトウェアの世界では、プロセスが完全に実行されるだけでなく、何らかの不備が原因で実行される状況に遭遇することがよくあります。この時点では、たとえ取引が専門的な方法で実行されなかったとしても、結果はプラスであるため、背景はあまり重要ではありません。この評価に基づいてクリーンコードの概念が生まれました。このコンテンツでは、コーディングの原則について説明します。 きれいなコード コンセプトについて説明し、その基本的なダイナミクスについて説明します。
クリーンコードとは何ですか?
記述されるコードにエラーがなく、理解しやすく、編集可能、折りたたみまたは展開可能である場合、このコードはクリーン コードと呼ばれます。 クリーンコードとは何ですか? この質問はこの最短の方法で答えることができます。もちろん、評価全体を数文で語ることはできません。一般的な概念に関する重要な情報は次のとおりです。
- 考え方も実装も簡単でなければなりません。混乱を避けることは、この概念の最も重要な特徴です。
- コードは、自分自身、または自分の後にコードを編集する人のことを考慮して、簡単に編集できる方法で作成する必要があります。
- ロバート・セシル・マーティンが書いたコンセプト 「クリーンなコード」 それは本と結びついて、そこから生まれました。
概念のダイナミクスは非常にシンプルであり、ソフトウェアの世界では非常に重要です。わかりやすいコードを書く際の間違いをなくし、より編集しやすいコードを書くために導入された概念です。このため、それは非常に重要であり、定期的な学習が必要です。
きれいなコードを書くには?
コードは理解しやすいものでなければなりません。これが基本的なダイナミクスです。ただし、コードが概念に含まれるためには、そのコードを書いた人だけでなく、後でそのコードを読んで編集する人にとっても理解しやすいコードでなければなりません。そうでない場合には 「悪いコード」 という概念に遭遇します。悪いコードが人間の資格に起因するものではないため、コードが容易に理解できないことは注目に値します。その他の重要な要素は次のとおりです。
- シンプルである必要があり、シンプルに書き、シンプルに読む必要があります。
- あなたの後にコードを扱う人のために、よりシンプルな環境を残しておく必要があります。
- エラーや脱落をすべて削除する必要があります。エラーなしで動作するという事実は、それが悪いコードであるという事実に変わりはありません。
- 複雑なコードで可読性を低下させないでください。より単純なコード スタイルを試してください。
- ポリモーフィズムを使用して、さまざまな構造に柔軟に対応する必要があります。
- 依存関係の注入の使用には注意してください。したがって、コードには依存関係が一切なく、独立して編集できます。
- 使用する変数、関数/メソッド、クラス名は明確でわかりやすいものでなければなりません。これに注意する必要があります。
- 命名は正しく行う必要があります。後で簡単に検索できることは非常に重要です。
- 使用する関数は複数の操作を実行しないでください。独自のジョブを実行する関数のみをコーディングする必要があります。
- 副作用を含む関数は避けてください。
- 不必要なコメント行は使用しないでください。また、コメント行は説明的なものにする必要があります。
- 関数の流れの方向は下向きである必要があり、インデントを中断してはなりません。
- 非静的メソッドの使用には注意してください。
上で見たように、クリーンなコードを作成するには、上記のダイナミクスを考慮する必要があります。もちろん、これらすべてのダイナミクスの実装は、コードを書いたり読んだりする人に依存します。このため、常にシンプルに、シンプルに読むように努める必要があります。
悪いコードとは何ですか?
コードを書いた人とそのコードが書かれた時間に関して言えば、時間、間違ったシステム、管理上のミスなどの問題を考慮すると、悪いコードが現れる可能性があります。この文脈では、クリーン コードの基準を満たしておらず、正しく機能していないコードは、 悪いコード と呼ばれます。では、どうすれば不正なコードを検出できるのでしょうか?
- 読んでわかりにくい場合は、
- 変更がほぼ不可能になった場合は、
- 不要なコードが多く、コードが読みにくい場合は、問題のあるコードに直面していると言えます。
では、本当に悪いコードというものは存在するのでしょうか?この概念が使用されている文献を見つけるのは難しくありません。しかし、そのような概念は使用すべきではないと述べている文献もあります。これは、悪いコードは人によって異なる意味を持つ可能性があるためです。このため、不良コードという概念を使用しないことをお勧めします。
ロバート・セシル・マーティンの名作 「クリーンなコード」 彼の本の中でこの概念に出会うことができます。この本には、悪いコードでも動作する可能性があるというテキストがあります。そこで、不良コードの概念について言及します。しかし、この問題に関してはすでに意見の相違があると言っても、それほど難しいことではありません。 「このコードは悪い。リファクタリングする必要がある。」という概念によく遭遇することを考えると、そのような概念が存在し、文献に含めるべきであることは明らかです。それで、コードは臭いますか？これを調べてみましょう。
コードの匂いとは何ですか?
トルコ語では、比喩、つまり文字通りではない意味を使ってより良い表現をすることができます。この状況により、私たちのトルコ語は大幅に改善され、表現力が強化されました。ここ コードの匂いがする、つまり、コードの臭いもこの例に該当します。比喩ですが、素晴らしい説明です。さて、 コードの匂いとは何ですか?
書かれたコードに理解できない部分があった場合、無駄なコードが繰り返されていた場合、説明したつもりが拡張されて読んでも何も理解できなかった場合、悪臭が鼻につきます。はい、このコードは臭いコード、つまりコードの臭いがするコードになりました。もちろん、ここには異なるダイナミクスがあります。これらについては別途注意が必要です。
コードの匂いを特定するには?
たとえその機能を完全に実行するとしても、長くて理解できない方法でこれを実行するコードは、悪臭のあるコードのクラスに属します。その最前線にある概念は次のとおりです。
- 重複 (コードの繰り返し): 繰り返しセクションがある場合に有効で、このコード構造をコピーして貼り付けることができます。 以下も参照してください。 二度と繰り返さない（DRY）原則
- 不明瞭さ: この概念は、コードが理解できず、読みにくい場合に注目を集めます。
- 剛性: 変更することはできません、変更したとしても、多くの場所に影響が及ぶ場合は有効になります。
- 冗長コード (不必要に長いコード): この概念は、より簡単な方法で実行できるアクションを過度に複雑にする場合に有効です。
上記の概念とその説明を注意深く検討すると、コードの匂いを簡単に理解できるようになります。
このコンテンツでは、 クリーンコードとは何ですか? きれいなコードを書くにはどうすればよいでしょうか?悪いコードとは何ですか?コードの匂いとは何ですか?などのたくさんの質問にお答えし、詳しく説明させていただきました。コメントセクションに意見や提案を表明して、コンテンツに貢献することもできます。
よくある質問
クリーンなコードに関してよくある質問をいくつかまとめました。