私の専門的な活動の長年にわたって、私はプログラムコードの大部分が「ひざの上に」、「急いで」、「締め切りの苦痛の下で」、その他に書かれているという意見を形成しました。 このコードは、常にリファクタリングされるだけでなく、ほとんどリファクタリングされません。 そのため、このコードを認識するのは困難です。 私は文句を言っていません。これは状況であり、劇的に変わる可能性は低いと理解しています。
しかし！ 開発者は忘れられないほど忘れられがちですが、他の人々と同様に自分自身を幸せにすることができるもの（もちろん、他のほとんどの人と同じように長い間知られています）があります。
1.関数、メソッド、クラス、変数にわかりやすい名前を付けます。 コードが「s」、「ss」、「sss」などの名前でいっぱいで、これらの変数のそれぞれに独自のタイプと目的がある場合、特に500行の長さのメソッドで常に使用されている場合、狼のようにlikeりたいです。 すべての人が100％理解できる場合を除き、 略語を使用しないでください （たとえば、 DOMDocumentクラスの変数に「 document_object_model_document 」という名前を付けるのは愚かですが、 CustomerCollectionクラスのオブジェクトに名前を付けるのはよくありません-「 ss 」：混乱の危険があります）。 最新の開発ツールは、オートコンプリートの多くの機会を提供するため、文字を節約しないでください。コードの理解度が低下します。 1つまたは2つの文字が異なる2つのメソッド名を指定しないでください （この文字の選択は完全にランダムであり、論理に適さない場合があります）。 多くの場合、どのケースでどのケースを使用するべきか、そしてどのケースで何を使用するべきかを理解することが不可能になった後に発生します。 名前はオブジェクトの値を反映する必要があります！
2.分割して征服する。 プログラムを小さな部分に分割します。 かなり膨大なタスクを1つ行うと、タスクが完了するまで1つの関数のシートを書き、書きたくなる傾向があることは明らかです。 しかし、あなた自身は、ある部分をコピーしてから別の部分をコピーする方法に気付かないでしょう。プログラムは、それ自体のしっかりしたコピー・ペーストになるリスクを負います。
3.関数およびメソッドのパラメーターの長いリストを避けるようにしてください 。 通常は3つまでに制限する必要があります（ただし、これは私の個人的な意見であり、独自の契約を設定できます）。 多くの場合、必要のない関数にパラメータを追加したいことがありますが、これは関数呼び出しを不必要に複雑にするだけです。 見て-多分、この新しいパラメーターが担当する作業の小さな部分を行う別の機能を強調する機会があります。 全能で普遍的な機能は、その堅牢性のためにしばしば悪いです。
4.コメントを書きます。 はい メソッド、関数、クラスに関するコメントを書きます。 コード内の不明瞭な場所、「一時的な」「パッチ」（通常、あなたは思っているよりも長生きし、その後、極度の困惑につながる可能性があります）。 メソッドまたは関数のシグネチャにコメントする場合、特にIDEがすべての種類の自動コンパイルのコメントに依存している場合（たとえば、PHPのIDEはこのように動作します）、シグネチャ自体を変更するときにコメントを必ず変更してください。
5.長いメソッドと大きなソースファイルを避けるようにしてください。 それらはナビゲートするのが困難です。 リファクタリングを実行します。確かに、重複を削除し、コードから余分な責任領域を削除する（独立したユニットに移動する）ことにより、ソースサイズを削減できます。
労働者への工場、プログラマへのコード！
All Articles