コードを見ると、どのものがすぐに警報を鳴らしますか？[閉まっている]

数週間前にソフトウェア職人のイベントに参加しましたが、コメントの1つは「見たときに悪いコードをすべて認識していると確信している」というもので、誰も議論することなく賢くうなずきました。

この種のことは、誰もが自分が平均以上のドライバーだと思っているという真実があるので、常に私を心配しています。悪いコードは認識できると思いますが、他の人がコードの匂いだと考えるものについては、人々のブログやほんの一握りの本で詳細に議論されることはめったにないので、もっと学びたいと思います。特に、ある言語ではコード臭があり、別の言語では臭いがないものについて聞くのは面白いと思います。

簡単なものから始めます。

コメントアウトされたコードの割合が高いソース管理のコード -なぜそこにあるのですか？削除するつもりでしたか？それは半分完成した作品ですか？多分それはコメントアウトされるべきではなく、誰かが何かをテストしているときにのみ行われたのでしょうか？個人的には、この種のことは、それがあちこちの奇妙な行であっても本当に迷惑だと感じますが、コードの残りの部分に大きなブロックが散在しているのを見ると、まったく受け入れられません。また、通常、残りのコードも疑わしい品質である可能性が高いことを示しています。

/* Fuck this error */

通常、ナンセンスtry..catchブロック内にあり、注意を引く傾向があります。同様に/* Not sure what this does, but removing it breaks the build */。

さらにいくつかのこと：

• 複数のネストされた複雑なifステートメント
• 定期的にロジックフローを決定するために使用されるtry-catchブロック
• 一般的な名前を持つ関数process、data、change、rework、modify
• 100行の6つまたは7つの異なるブレーススタイル

私が見つけたもの：

/* Stupid database */
$conn = null;
while(!$conn) {
    $conn = mysql_connect("localhost", "root", "[pass removed]");
}
/* Finally! */
echo("Connected successfully.");

なぜなら、MySQL接続を総当たり攻撃するのは正しいやり方だからです。データベースの接続数に問題があるため、タイムアウトが続いていたことがわかりました。これをデバッグする代わりに、彼らはそれが機能するまで何度も何度も試みました。

私にとって大きな危険は、コードブロックが重複していることです。これは、その人がプログラミングの基礎を理解していないか、既存のコードベースに適切な変更を加えるのが怖すぎることを示しているためです。

以前はコメントの欠如を危険信号とみなしていましたが、最近はコメントを付けずに非常に優れたコードの多くを作成しました。

実際の価値を追加しないにもかかわらず、プログラマーがどれほど賢いかを見せようとするコード：

x ^= y ^= x ^= y;

• 20,000（誇張）行関数。2つ以上の画面を必要とする関数では、リファクタリングが必要です。

• 同じ行に沿って、永遠に続くように見えるクラスファイル。すべての内部メソッドである場合を除き、元のクラスの目的と機能、およびおそらくそれが使用されている場所を明確にするクラスに抽象化できる概念がおそらくいくつかあります。

• 非記述的、非自明な変数、または自明でない非記述的変数が多すぎる。これらは、実際に何が起こっているのかを推測することを謎にしています。

{ Let it Leak, people have good enough computers to cope these days }

さらに悪いことに、それは商業図書館のものです！

非常に冗長なコメントで、英語のコンパイラーがあれば、それは完全にコンパイルおよび実行されますが、コードにはないことは何も説明しません。

//Copy the value of y to temp.
temp = y;
//Copy the value of x to y.
y = x;
//Copy the value of temp to x.
x = temp;

また、廃止された可能性のあるコードに関するコメントでは、コードがいくつかの基本的なガイドラインに準拠していました。

//Set the age of the user to 13.
a = 13;

コンパイル時に警告を生成するコード。

以下のように、説明的な名前ではなく、名前に数字が含まれる関数：

void doSomething()
{
}

void doSomething2()
{
}

関数名に何か意味があるようにしてください！doSomethingとdoSomething2が同様のことを行う場合、違いを区別する関数名を使用します。doSomething2がdoSomethingからの機能のブレイクアウトである場合、その機能に名前を付けます。

マジックナンバーまたはマジックストリング。

   if (accountBalance>200) { sendInvoice(...); }

   salesPrice *= 0.9;   //apply discount    

   if (invoiceStatus=="Overdue") { reportToCreditAgency(); }

• 最悪ではないかもしれませんが、明らかに実装者レベルを示しています。

  if(something == true) 

• 言語にforループまたは反復子の構造がある場合、whileループを使用すると、言語の実装者レベルの理解も実証されます。

  count = 0; 
  while(count < items.size()){
     do stuff
     count ++; 
  }
  
  for(i = 0; i < items.size(); i++){
    do stuff 
  }
  //Sure this is not terrible but use the language the way it was meant to be used.
  

• ドキュメンテーション/コメントのつづり/文法の悪さは、コードとほぼ同じくらい私を食い物にします。これは、コードは人間が読み取り、マシンを実行するためのものであるためです。私たちが高レベル言語を使用しているのはこのためです。もしあなたのドキュメンテーションがそれを通り抜けるのが難しいなら、私はそれを見ないでコードベースの否定的な意見を先制的に形成させます。

すぐに気づくのは、深くネストされたコードブロックの頻度（if、whileなど）です。コードが頻繁に2つまたは3つのレベルよりも深く進んでいる場合、それは設計/ロジックの問題の兆候です。そして、それが8つのネストの深さのようになった場合、それが分解されないためのかなり良い理由があります。

学生のプログラムを採点するとき、私は時々「瞬き」スタイルの瞬間に伝えることができます。これらは即時の手がかりです：

• 不十分または一貫性のないフォーマット
• 3行以上の空白行
• 非標準または一貫性のない命名規則
• 繰り返されるコード、繰り返しが逐語的になればなるほど、警告は強くなります
• 単純なコードである必要があるものは、非常に複雑です（たとえば、複雑な方法でmainに渡された引数をチェックする）

私の最初の印象が間違っていることはめったになく、これらの警告ベルはほぼ95％の割合で正しいです。例外として、この言語を初めて使用する学生は、異なるプログラミング言語のスタイルを使用していました。他の言語のイディオムで自分のスタイルを掘り下げて読み直すと、私にとっては警告音がなくなり、学生は完全に評価されました。しかし、そのような例外はまれです。

より高度なコードを検討するとき、これらは私の他の警告です：

• データを保持するための「構造体」にすぎない多くの Javaクラスの存在。フィールドがパブリックであるかプライベートであり、ゲッター/セッターを使用するかは重要ではありませんが、考え抜かれたデザインの一部ではない可能性があります。
• 単なる名前空間であり、コードに本当の凝集度がないなど、名前が貧弱なクラス
• コードでさえ使用されていないデザインパターンへの参照
• 説明のない空の例外ハンドラ
• Eclipseでコードをプルアップすると、何百もの黄色の「警告」がコードに並んでいますが、これは主に未使用のインポートまたは変数が原因です

スタイルの観点から、私は一般的に見たくない：

• コードをエコーするだけのJavadocコメント

これらは悪いコードの手がかりにすぎません。プログラマーの意図がわからないため、悪いコードのように見えるかもしれませんが、実際にはそうではありません。たとえば、何かが過度に複雑に思える正当な理由があるかもしれません-遊びで別の考慮事項があったかもしれません。

個人的なお気に入り/ペットのピーブ：コミットされたIDE生成の名前。TextBox1がシステム内の主要かつ重要な変数である場合、コードレビューが近づいています。

特に使用されている変数名に似た名前の変数の場合は、完全に未使用の変数。

多くの人々が言及しています：

//TODO: [something not implemented]

私はそれらが実装されたことを望みますが、少なくとも彼らはメモしました。私が悪いと思うのは：

//TODO: [something that is already implemented]

あなたがそれらを削除することを決して気にしないなら、Todoは価値がなく、混乱しています！

すべてを読むために下にスクロールする必要がある方法。

メソッド名の接続詞：

public void addEmployeeAndUpdatePayrate(...) 


public int getSalaryOrHourlyPay(int Employee) ....

明確化：これが警告を鳴らす理由は、メソッドが単一の責任原則に違反している可能性が高いことを示しているためです。

明らかにGPLのソースコードを商用のクローズドソースプログラムにリンクする。

それはすぐに法的問題を引き起こすだけでなく、私の経験では、通常、コードの別の場所にも反映されている不注意または無関心を示しています。

言語に依存しない：

• TODO: not implemented
• int function(...) { return -1; } （「実装されていない」と同じ）
• 非例外的な理由で例外をスローします。
• の誤用または一貫性のない使用0、-1またはnull例外的な戻り値として。
• なぜ失敗しないのかを説得するコメントのないアサーション。

言語固有（C ++）：

• 小文字のC ++マクロ。
• 静的またはグローバルC ++変数。
• 初期化されていない変数または未使用の変数。
• どれarray new明らかにRAII-安全ではありませんこと。
• 明らかに境界セーフではない配列またはポインターの使用。これにはが含まれprintfます。
• 配列の初期化されていない部分の使用。

Microsoft C ++固有：

• Microsoft SDKヘッダーファイルのいずれかで既に定義されているマクロと衝突する識別子名。
• 一般に、Win32 APIを使用すると、警告音が鳴ります。常にMSDNを開いて、疑わしいときはいつでも引数/戻り値の定義を調べてください。（編集済み）

C ++ / OOP固有：

• 親クラスに仮想メソッドと非仮想メソッドの両方がある実装（具体的なクラス）の継承。

奇妙なインデントスタイル。

いくつかの非常に人気のあるスタイルがあり、人々はその議論を墓場に持ち込むでしょう。しかし、時々私は誰かが本当に珍しい、あるいは自家製のインデントスタイルを使用しているのを見ます。これは、彼らがおそらく自分自身以外でコーディングしていないことを示しています。

列挙型またはグローバルに定義された変数ではなく、多くのテキストブロックを使用します。

良くない：

if (itemType == "Student") { ... }

より良い：

private enum itemTypeEnum {
  Student,
  Teacher
}
if (itemType == itemTypeEnum.Student.ToString()) { ... }

ベスト：

private itemTypeEnum itemType;
...
if (itemType == itemTypeEnum.Student) { ... }

メソッドの弱い型指定のパラメーターまたは戻り値。

public DataTable GetEmployees() {...}

public DateTime getHireDate(DataTable EmployeeInfo) {...}

public void FireEmployee(Object EmployeeObjectOrEmployeeID) {...}

• 複数の三項演算子が連結されているため、if...elseブロックに似ているのではなく、ブロックになりif...else if...[...]...elseます
• アンダースコアまたはcamelCasingのない長い変数名。私がプルアップしたコードの例：$lesseeloginaccountservice
• ファイル内の数百行のコード、コメントはほとんどまたはまったくなく、コードは非常に非自明です
• 過度に複雑なifステートメント。コードからの例：if (!($lessee_obj instanceof Lessee && $lessee_obj != NULL))私がぎっしり詰めたif ($lessee_obj == null)

コードの匂い：ベストプラクティスに従っていない

この種のことは、誰もが自分が平均以上のドライバーだと思っているという真実があるので、常に私を心配しています。

yaのニュース速報は次のとおりです。世界の人口の50％が平均的な知能を下回っています。わかりましたので、一部の人々は正確に平均的な知性を持っているでしょうが、うるさくなりません。また、愚かさの副作用の1つは、あなた自身の愚かさを認識できないことです！これらのステートメントを組み合わせると、物事はそれほど良く見えません。

コードを見ると、どのものがすぐに警報を鳴らしますか？

多くの良いことが述べられていますが、一般的にベストプラクティスに従わないことはコードの匂いです。

通常、ベストプラクティスはランダムに考案されたものではなく、多くの場合、理由があります。多くの場合、それは主観的である可能性がありますが、私の経験ではほとんど正当化されています。ベストプラクティスに従うことは問題ではないはずです。なぜそうなっているのか疑問に思っている場合は、それを無視したり、文句を言ったりするのではなく、研究してください。

ベストプラクティスの1つの例は、1行しか含まれていない場合でも、すべてのifブロックでカーリーを使用することです。

if (something) {
    // whatever
}

あなたはそれが必要だとは思わないかもしれませんが、私は最近それがバグの主な原因であることを読みました。Stack Overflowでは常にブラケットの使用についても説明されています。ifステートメントにブラケットがあることを確認することは、Javaの静的コードアナライザーであるPMDのルールでもあります。

覚えておいてください：「それがベストプラクティスだから」は、「なぜあなたはこれをしているのですか？」という質問に対する容認できる答えではありません。何かがベストプラクティスである理由を明確にできない場合、それはベストプラクティスではなく、迷信です。

「これは、frozサブシステムの設計が完全に損なわれているためです」と言うコメント。

それは段落全体にわたって続きます。

彼らは、次のリファクタリングを行う必要があることを説明しています。

しかし、それをしませんでした。

今、彼らは、時間や能力の問題のために、上司によってそれを変更できないと言われたかもしれませんが、おそらくそれは人々がささいなためでした。

スーパーバイザーがj.randomと考えている場合。プログラマーはリファクタリングを実行できません。スーパーバイザーが実行する必要があります。

とにかくこれは起こりますが、コードは分割されたチームによって書かれており、権力の政治があり得るので、中途半端なサブシステム設計をリファクタリングしませんでした。

実話。それはあなたに起こる可能性があります。

絶対パスでコードを合法的にファイルを参照する必要がある例を考えることができますか？

一般的な例外をキャッチする：

try {

 ...

} catch {
}

または

try {

 ...

} catch (Exception ex) {
}

リージョンの過剰使用

通常、使用するリージョンが多すぎるということは、クラスが大きすぎることを示しています。これは警告フラグであり、そのコードをさらに調査する必要があることを示しています。

作成しようとしている抽象化に対する不十分な理解を示すクラス命名規則。または、抽象化をまったく定義しません。

極端な例は、タイトルが付けDataられ、最初のファイルで30,000行以上だったVBクラスで思い浮かびます。少なくとも半ダースの他のファイルに分割された部分的なクラスでした。ほとんどのメソッドは、などの名前を持つストアドプロシージャのラッパーFindXByYWithZ()です。

それほど劇的ではない例でさえ、完全に一般的なタイトルを与えられ、後でそれを後悔しているので、私たちはみな、考えの悪いクラスにロジックを「ダンプ」したに違いない。

言語の基本機能を再実装する関数。たとえば、JavaScriptで文字列の「.length」プロパティの呼び出しの代わりに「getStringLength（）」メソッドが表示された場合、問題があることがわかります。

#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...

もちろん、いかなる種類のドキュメントも、時々ネストされた#defines もありません