基準に従う

ベストプラクティス3-定義された標準に従い、作成しないでください

標準的なソフトウェア組織のほとんどは、コーディング標準を維持しています。これらの標準は、ソフトウェア開発に何年も費やした後、経験豊富なソフトウェア開発者によって設定されたはずです。これは、彼らの後ろに残された偉大な人々の足跡をたどることに相当します。

組織に標準がない場合は、インターネットでさまざまなプログラミング言語のコーディング標準を検索することをお勧めします。多くの言語が見つかります。コーディング標準は、コードのさまざまな重要な属性に関するルールを修正します。以下にリストされているものはほとんどありません。

  • ファイルの命名規則
  • 関数とモジュールの命名規則
  • 変数の命名規則
  • 履歴、インデント、コメント
  • 読みやすさのガイドライン
  • すべきこととすべきでないことのリスト

ただし、一度定義したら、毎日作成または変更するのではなく、定義された標準に従い始めます。私は間違いなく言うでしょう:

ソースコードはあなたの赤ちゃんです!

だから、それを清潔で、一貫性があり、美しく保つ。私が美しいと言うとき、それは本当に美しいという意味です。あなたのコードが美しく見えるなら、他の人がそれを読んで理解するのは簡単でしょう。コーディング規則を毎日変更し続けると、数日後には、自分で作成したコードを読んで理解することができなくなります。