プロジェクト内の悪いコードの匂いを探す (ネーミング) プロジェクトの業界コードリスト プロジェクトの規律とコード Javaee プロジェクトのソースコード

はじめに

この期間中、私はプロジェクトに取り組んできたので、比較的忙しかったのですが、今日はようやく自分が書いたコードをじっくり見て、どこに問題があるのか​​、どこに問題があるのか​​を確認する時間ができました。悪臭」。

時間をかけてゆっくりとコードを思い出してください。悪臭をキャッチし始めます。

私たちがよく行うことと考えること

曖昧な if 条件

1) || の処理に時間を費やす

コードの行数を減らすことは良い目標ですが、コードを理解するのにかかる時間は、さらに良い目標です。

戻り値

上記の「$ret」は「名前が思いつかない」という言い訳です。このような空の名前を使用するのではなく、エンティティの価値や目的を説明する名前を選択してください。

$alias は、この変数がエイリアスを運ぶために使用されることを宣言し、この変数の目的を示します。欠陥の発見にも役立つかもしれません

適切な名前は、変数の目的または変数が持つ値を説明するものでなければなりません。

一時変数

ここでの $i は「私の一時変数」であり、統計データを自動的に増やし、統計ポイントの重複を避けるために特別に使用されます。しかし、$i について最も重要なことは一時変数ではありません。 charset_index を使用して「統計データの添字」を表すと、より「説明的」になります。

ループ反復子

私も私の JS コードで悪臭を発見しました。

i 変数名は非常に一般的なので、使用しないでください。

i、j、iter、it などの名前は、インデックスやループ反復子としてよく使用されます。名前は曖昧ですが、「私は反復者です」という意味であることは誰もが知っています。 - 実際、これらの名前を別の意味で使用すると、混乱を招く可能性があります。だからやめてください。

i、j、it などのあいまいな名前を使用することに固執する場合は、自分を納得させる十分な理由が必要です。

まとめ

コーディングプロセス中にさらに数秒かけて適切な名前を考え出すと、「命名能力」がすぐに向上することがわかります。

私は通常、中国語の名前を最初に考えます。対応する英語の名前がどうしても思いつかない場合は、翻訳ツールを使用して思いついた中国語の名前を貼り付けてから、名前付きの変数または関数の名前を切り取ります。

最近見た素敵な名前をプレゼントしてください

元のリンク: http://www.cnblogs.com/baochuan/archive/2012/07/12/2588317.html

上記は、プロジェクトとコードの側面を含めて、プロジェクト内でコードを探すときの嫌な臭い (ネーミング) を紹介しました。PHP チュートリアルに興味のある友人の参考になれば幸いです。