入力されていないように見えるコードを安全に削除するにはどうすればよいですか？

余分に見えるコードを見つけましたが、コンパイラーはそれに気付きません。このコードを削除してもリグレッションが発生しないことを確認する（またはできる限り確実に近くする）ために何をしますか。

2つのアイデアが思い浮かびます。

1. 「単純に」、コードが実行されるように見えるかどうかに基づいて演deを使用します。ただし、これは複雑で時間のかかる作業であり、実質的なビジネスリターンが得られないため、わずかにリスクが高い（評価がエラーになりやすい）場合があります。

2. そのコードセクションにロギングを配置し、実際に入力される頻度を確認します。十分な実行後、コードを削除しても安全であると合理的に確信できます。

より良いアイデアや標準的なアプローチのようなものはありますか？

100％の単体テストカバレッジがある私の完璧なファンタジーの世界では、それを削除して単体テストを実行し、赤にならないテストがなければコミットします。

しかし残念なことに、私は毎朝目を覚まし、多くのコードに単体テストがないか、存在するすべてのエッジケースを実際にカバーすることを信頼できないという厳しい現実に直面しなければなりません。だから私はリスク/報酬を考慮し、それは単に価値がないという結論に達します：

• 報酬：コードは将来維持するのが少し簡単です。
• リスコーダー自身ではない利害関係者に。

このプロセスには2つの半分があります。1つ目は、コードが実際に死んでいることを確認することです。2つ目は、間違っているコストを把握し、適切に軽減することです。

ここでの多くの回答には、前半に対する優れた解決策があります。静的アナライザーなどのツールは、デッドコードの特定に最適です。 grep場合によってはあなたの友達になれます。私がよくとる珍しい手順の1つは、コードの本来の目的が何であるかを特定することです。「Xは製品の機能ではなくなり、コードセグメントYは機能Xをサポートするように設計されました」と言うのは、「コードセグメントYの目的がわからない」と言うよりもはるかに簡単です。

後半は、コードを削除する必要があるかどうかを判断するための重要なステップです。答えが間違っていることの意味を理解する必要があります。答えが間違っていると人々が死ぬのであれば、注意してください！たぶん、コードクラフトが時間の経過とともに発展することを受け入れ、代わりに自分でもっとクラフティングを書かないようにしようとするのが良い時期かもしれません。人々が死なない場合は、ユーザーがどの程度寛容であるかを自問してください。何かを破って顧客との関係を維持した場合、修正プログラムを送信できますか？このような問題を見つけるために支払われるQ＆Aチームはありますか？これらの種類の質問は、削除キーを押す前にどれだけ確実でなければならないかを理解するために不可欠です。

コメントの中で、rmunは、削除する前にコードの本来の目的を理解するという概念の優れた表現を指摘しました。引用は現在チェスタートンのフェンスとして知られています。コメントで直接引用するには大きすぎますが、ここで適切に引用する価値があると思います。

物事を変形させることとは異なり、物事を改革することに関しては、1つの単純で単純な原則があります。おそらくパラドックスと呼ばれる原理。そのような場合、特定の機関または法律が存在します。簡単にするために、道路の向こう側にフェンスまたはゲートを設置しました。より近代的なタイプのリフォーマーは、これに積極的に取り組んでおり、次のように述べています。よりインテリジェントなタイプのリフォーマーは、答えを出すのにうまくいくでしょう。離れて考えてみてください。それから、戻ってきて、その使用を確認したと言ったら、私はあなたにそれを破壊することを許すかもしれません。

またgrep、コード内の関数/クラス名を使用する傾向があります。これにより、たとえば、コメントやドキュメントファイル、またはスクリプトで名前が言及されている場合など、コードアナライザーにはない追加の利点が得られます。ソースツリーのファイルに対してgrepを実行し、結果をファイルに保存します。通常、結果は要約された情報を提供します：ファイル名/パス、行番号、名前が出た行、これは関数/クラスが呼び出されたり、意味的な意味なしに言及されている場所の手がかりを与えることができます（コードアナライザとは対照的に）、およびファイル拡張子に関係なく。間違いなく究極のソリューションではなく、分析への素晴らしい追加です。

• 死んでいるように見えるコードを特定します（静的分析など）。
• 死んだとされるコードの呼び出しごとにログメッセージを追加します。関数/メソッドを使用すると簡単です。定数のような静的メンバーを使用すると、扱いにくくなります。コードを非推奨としてマークするだけで、ランタイムが自動的にメッセージを記録する場合があります。それ以外のコードはそのままにしておきます。
  • デッドモジュールがロードされたときにメッセージをログに記録します。ほとんどの言語には、ロード時に静的初期化を実行する方法があります。
  • ログメッセージに適切なスタックトレースが含まれていることを確認して、デッドコードと呼ばれるものを理解できるようにしてください。
• 変更したコードをすべてのテストスイートで実行します。また、テストスイートは、真夜中を越える、四半期の変わり目、年の変わり目などの特別な時間についてもテストする必要があります。ログを見て、何が死んでいるかの理解を更新します。単体テストは具体的にデッドコードをテストする可能性がありますが、他の単体テストや統合コードはそれに触れないことに注意してください。
• 変更されたコードを本番環境で数週間実行します。月に一度のETL cronジョブなど、すべての定期的なプロセスがこの期間中に実行されるようにしてください。
• ログを見てください。ログに記録されたものは、実際には死んでいません。残りのデッドコードに対するコールグラフの推移的閉包も、呼び出されていなくても潜在的にデッドではありません。分析してください。たぶん、いくつかのブランチは安全に死んでいます（たとえば、今では絶滅したサービスのAPIを使って作業しています）が、まだブランチはありません。モジュール/クラス全体は、その中に定義された定数に対してのみロードされ、簡単に使用できます。
• 残っているものはすべて安全に死んでおり、削除することができます。

前述の既存の回答に加えて、複数のバージョンでコードを繰り返し削除することもできます。

初期バージョンでは、機能しているコードブロックで非推奨の警告を行うことができました。その後のバージョンでは、コードブロックを削除できますが、エラーメッセージを残して、ユーザーにこの機能を非推奨にし、使用できなくなります。最終バージョンでは、コードブロックとメッセージを削除します。

これは、エンドユーザーへの警告なしで予期しない機能を識別するのに役立つ場合があります。最良のシナリオでは、コードは実際には何もせず、発生することは、不要なコードが削除される前にいくつかのバージョンにわたって保持されることだけです。

多くの人々は、「安全な」ことは、コードが使用されていないことを証明できない場合にコードを残すことだと提案しています。

しかし、コードは資産ではなく、負債です。

それが重要である理由を説明し、そのテストを示すことができない限り、「より安全な」代替手段はそれを削除することです。

それでもわからない場合は、少なくともゾンビコードを実行するためのテストを追加してください。

機能トグルを使用して、ソフトウェアの実行パスを変更し、問題のコードを完全に無視することができます。

これにより、使用していないコードを使用して変更を安全に展開し、トグルをオフにできます。コードに関連する重大な障害に気付いた場合は、トグルをオンに戻し、コードへの可能なパスを調査してください。

このアプローチは、長期間にわたって問題が見られない場合の信頼性と、ライブw / oaデプロイメントでそれを元に戻す機能を提供します。ただし、さらに良い方法は、問題のある領域の周りに追加のロギングとテストカバレッジを適用し、使用されているかどうかの証拠を提供することです。

トグルの詳細については、https：//martinfowler.com/articles/feature-toggles.htmlをご覧ください。

もちろん静的分析...そして、素晴らしいことは、新しいツールは必要ないということです。コンパイラには、必要な静的解析ツールがすべて備わっています。

メソッドの名前を変更DoSomethingし（例：に変更DoSomethingX）、ビルドを実行します。

ビルドが成功した場合、このメソッドは明らかに何も使用されていません。削除しても安全です。

ビルドが失敗した場合、それを呼び出すコード行を分離しif、呼び出しを囲むステートメントを確認して、呼び出し方法を決定します。トリガーとなる可能性のあるデータユースケースが見つからない場合は、安全に削除できます。

あなたはそれを削除することについては本当に心配している場合は、コードを維持するが、とそれをマーキング考えるObsoleteAttribute（またはあなたの言語で同等）。1つのバージョンのようにリリースし、問題が発見されなくなったらコードを削除します。

• コードアナライザーを使用して、これがデッドコードかどうかを確認します
• テストの確認を開始し、コードに到達しようとしました。テストケース内のコードに到達できない場合、デッドコードである可能性があります
• コードを削除して、代わりに例外をスローします。1つのリリースでは例外がアクティブになり、2番目のリリースでは例外を削除できます。安全のために、顧客が例外に気付いたときに元のコードをアクティブにできるように、緊急フラグ（Javaではシステムプロパティ）を配置します。したがって、例外を無効にして、元のコードを実稼働環境でアクティブ化できます。

到達不能コードの削除

原則的な静的型付け言語では、コードが実際に到達可能かどうかを常に知っておく必要があります。それを削除し、コンパイルします。エラーがなければ到達できません。

残念ながら、すべての言語が静的に型付けされているわけではなく、すべての静的に型付けされた言語が原則化されているわけでもありません。問題が発生する可能性のあるものには、（1）リフレクションと（2）原則のないオーバーロードが含まれます。

動的言語、または精査中のコードの一部が実行時にリフレクションを介してアクセスされる可能性がある十分に強力なリフレクションを持つ言語を使用する場合、コンパイラーに頼ることはできません。そのような言語には、Python、Ruby、またはJavaが含まれます。

原則的なオーバーロードのない言語を使用している場合、オーバーロードを削除するだけで、オーバーロード解決を別のオーバーロードにサイレントに切り替えることができます。そのような言語の中には、コードの使用に関連するコンパイル時の警告/エラーをプログラムできるものがあります。そうしないと、コンパイラに頼ることができません。このような言語には、Java（使用@Deprecated）またはC ++（使用[[deprecated]]または= delete）が含まれます。

したがって、厳密な言語で作業することが非常に幸運でない限り（Rustが思い浮かびます）、コンパイラーを信頼することで、実際に足を踏み入れるかもしれません。また、残念なことにテストスイートは一般的に不完全であるため、これ以上の助けもありません。

次のセクションをキュー...

潜在的に未使用のコードを削除する

それどころか、コードが実際に参照されている、しかし、あなたは疑いの練習でそれを参照するコードの枝が取られることはありませんことを。

この場合、言語に関係なく、コードは明らかに到達可能であり、ランタイムインスツルメンテーションのみを使用できます。

過去に、私はこのようなコードを削除するのに3段階のアプローチをうまく使用しました：

1. 実行されないことが疑われる各ブランチで、警告をログに記録します。
2. 1サイクル後、特定のコードを入力すると例外をスロー/エラーを返します。
3. 別のサイクルの後、コードを削除します。

サイクルとは何ですか？コードの使用サイクルです。たとえば、金融アプリケーションの場合、短い月間サイクル（月末に給与が支払われる）と長い年次サイクルが予想されます。この場合、年末の在庫に対して警告が発せられないことを確認するために少なくとも1年待つ必要があります。

うまくいけば、ほとんどのアプリケーションのサイクルが短くなります。

私は、次のステップに進むべき時期について助言する、日付とともにTODOコメントを書くことをお勧めします。カレンダーのリマインダー。

本番からコードを削除することは、家を掃除するようなものです。あなたが屋根裏部屋から物を捨てた瞬間、あなたの妻は1923年に亡くなった隣人からの偉大な祖母の3番目のthirdの帰郷の贈り物を捨てて翌日あなたを殺します。

真剣に、誰もが既に言及したさまざまなツールを使用した大まかな分析の後、および既に言及した段階的な廃止アプローチを使用した後、実際の削除が行われると会社から消えることがあることに留意してください。コードをそのままにして実行を記録し、実行のアラートが確実に確実にユーザー（または後継者と担当者）に伝達されるようにすることが不可欠です。

このアプローチに従わないと、妻に殺される可能性が高くなります。（すべての記念品のように）コードを保持する場合、ムーアの法則があなたの救助に来るという事実と、「私の靴の岩」のように感じるコードによって使用されるジャンクディスクスペースのコストで良心を休めることができます年になり、複数のウォータークーラーゴシップや廊下の奇妙な外観の中心になるリスクはありません。

PS：コメントへの応答で明確にするために..元の質問はもちろん「どうやって安全に削除するか..」です。もちろん、私の答えではバージョン管理が想定されています。貴重品を見つけるためにゴミを掘るようなものです。いかなる意味のあるボディもコードを捨てることはなく、バージョン管理はすべての開発者の厳格さの一部であるべきです。

問題は、余分なコードに関するものです。実行パスの100％が到達しないことを保証できない限り、コードが不要であることを決して知ることはできません。そして、これはこの保証が不可能に近いほど十分に大きいソフトウェアであると想定されています。そして、質問を間違って読んでいない限り、この会話のスレッド全体が関連するのは、削除されたコードが呼び出される可能性がある実稼働中の場合のみです。したがって、ランタイム/実稼働の問題があります。バージョン管理は、実稼働の失敗のために誰の背後にも保存されません。そのため、「バージョン管理」に関するコメントは、質問または私の元のポイントに関連しません。

私見、コメントは不要であり、削除の候補です。

たぶん、コンパイラーはそれに気づいて、大騒ぎしません。

サイズに合わせて、完全なコンパイラ最適化でビルドを実行します。次に、疑わしいコードを削除し、ビルドを再度実行します。

バイナリを比較します。それらが同一である場合、コンパイラはコードに気づき、静かに削除しました。ソースから安全に削除できます。

バイナリが異なる場合...それは決定的ではありません。他の変更が必要になる場合があります。コンパイラの中には、コンパイルの日付と時刻をバイナリに含めるものもあります（そして、それは離れて設定できるかもしれません！）

私は最近、「deleteFoo」と呼ばれるメソッドを使用して、この正確な状況に最近遭遇しました。メソッド宣言以外の文字列はコードベース全体のどこにも見つかりませんでしたが、私は賢明にもメソッドの先頭にログ行を書きました。

PHP：

public function deleteFoo()
{
    error_log("In deleteFoo()", 3, "/path/to/log");
}

コードが使用されたことがわかりました！一部のAJAXメソッドは、「method：delete、elem = Foo」を呼び出します。このメソッドは、連結されてcall_user_func_array（）で呼び出されます。

疑わしい場合は、ログに記録してください！ログがいっぱいにならないまま十分な時間を過ごした場合は、コードを削除することを検討してください。ただし、コードを削除した場合でも、ログを残し、日付をコメントとして残しておくと、Gitでコミットを見つけやすくなります。

grep最初に使用可能なツールを使用すると、コードへの参照が見つかる場合があります。（もともと私の指示/アドバイスではありません。）

次に、コードを削除するリスクがあるかどうか、または私の提案が使用できるようになるかどうかを決定します。

コードの関数/ブロックを変更して、ログファイルに使用されたことを書き込むことができます。そのようなメッセージがログファイルに「これまで」記録されていない場合は、おそらくログコードを削除できます。

2つの問題：

1. 他のユーザーからログを取得します。 おそらく、終了時にプログラムをクラッシュさせるグローバルフラグを設定し、ユーザーに親切にエラーログを送信するように依頼することができます。

2. 呼び出し元をトレースします。 一部の高レベル言語（Pythonなど）では、トレースバックを簡単に取得できます。ただし、コンパイルされた言語では、リターンアドレスをログに保存し、終了時にコアダンプを強制する必要があります（ポイント1）。
   Cでは、これは非常に単純なはずです。条件付きブロック（たとえば#ifdef ... #endif）を使用して、動作することがわかっている（そして動作することをテストした）ときにのみこれを使用し、単にリターンアドレスを読み取るスタックから（インラインアセンブリ言語が必要な場合と必要でない場合があります）。

ログファイルに引数を保存することは、役に立つ場合とできない場合があります。

それを取り巻くコードが何をしているのかを知っているなら、それをテストして、それが壊れているかどうか確かめてください。これは、作業中のコードをリファクタリングするための最も簡単で費用対効果の高い方法であり、最初に作業中のコードに変更を加える場合は、とにかく実行する必要があります。

一方、あなたはしていないコードの一部リファクタリングしている場合は知っている、それが何を、それを削除しないでください。最初にそれを理解してから、安全であると判断した場合にリファクタリングします（リファクタリングが時間の適切な使用であると判断できる場合のみ）。

現在、「死んだ」コードが実際には何にも接続されていない状況があります（私は自分でそれに遭遇したことを知っています）。アプリが配信された直後に廃止されたために実際にどこにも実装されなかった請負業者によって開発されたコードのライブラリなど（なぜそうですか、私は具体的な例を念頭に置いています、どうやって知っていますか？）

私は個人的にこのコードのすべてを削除する羽目になるでしたが、それは巨大な私は軽く上の服用はお勧めしませんリスク-この変更は可能性がどのくらいのコードに応じて、潜在的に（あなたが何かを見落としてきた可能性が常に存在だから）、あなたに影響を与えます非常に注意して、積極的なユニットテストを実行して、この古いレガシーコードを削除してもアプリケーションが破損するかどうかを判断する必要があります。

言われていることはすべて、おそらくそのようなコードを削除しようとするのは時間や正気の価値はないでしょう。アプリケーションで深刻な問題にならない限り（たとえば、アプリケーションの肥大化のためにセキュリティスキャンを完了できない...なぜそうなのかまだ念頭に置いているので）、そうしないとお勧めできません。このような状況では、コードが本当にインパクトのある方法で腐敗し始めています。

要するに、コードが何をするのかを知っているなら、最初にテストしてください。そうでない場合は、おそらくそのままにしておくことができます。あなたが知っている場合することができないだけで、それを残して、変更を実装する前に積極的な変化をテストするためにあなたの時間を捧げます。

私のアプローチは、この場合常に業界標準であると想定していましたが、奇妙なことにこれまで言及されていませんでした。

2番目のペアを取得します。

さまざまな種類の「未使用のコード」があり、場合によっては削除が適切であり、他の場合はそれをリファクタリングする必要があります。あなたはそれがどれであるかを把握する必要があり、そうするためにあなたは最高の2番目とペアを組む-経験豊富です！-開発者、コードベースに精通している人。これにより、不必要なミスのリスクが大幅に削減され、必要な改善を行ってコードベースを保守可能な状態に保つことができます。そして、これを行わないと、ある時点で、コードベースに精通している開発者を使い果たしてしまいます。

ロギングアプローチも見てきました。より正確には、ロギングコードを見ました。10年の間、そこに残っていたさらに多くのデッドコードです。ロギングアプローチは、機能全体を削除する場合はかなり適切ですが、デッドコードの一部を削除するだけではありません。

あなたの質問に対する簡単な答えは、あなたが理解していないコードを安全に削除できないということです。多少のリスクがあります。

その避けられないリスクを軽減する最善の方法を判断する必要があります。他の人はロギングについて言及しています。ロギングは、もちろんそれが使用されていることを証明できますが、使用されていないことを証明することはできません。デッドコードの主な問題はそれが維持されることであるため、デッドコードの疑いがあるというコメントを追加することで逃げることができ、それを維持することはできないかもしれません。

コードがソース管理下にある場合は、いつコードが追加されたかをいつでも確認し、そのときの呼び出し方法を判断できます。

最終的に、あなたはそれを理解するか、そのままにしておくか、チャンスをつかむかのいずれかです。

問題のコードの開発者がまだ利用できる場合は、彼と一緒にコードの削除を確認してください。また、コードのコメントを読んでください。

適切な説明、このコードが追加された理由、およびそれが機能する機能が表示されます。特定のユースケースを簡単にサポートすることもできますし、本当に必要でないかどうかを判断するのに十分な専門知識がない場合もあります。極端な場合、Cプログラムからすべての空きステートメントを削除し、間違ったことに気付かないことがあります（メモリ不足になるまで数分かかる場合があります）。

コードの作者があなたの隣に座っているのは本当に悪い文化ですが、彼は悪いコードを書いているだけで、あなたのものはすべて完璧なので、話す理由はありません。そしてもちろん、彼はコメントにランダムな単語を書くだけで、読書を無駄にする必要はありません。

コードにコメントを記述する最も重要な理由の1つは、この方法で実装された理由を説明することです。解決策に同意しない場合もありますが、問題を考慮する必要があります。

著者との議論はまた、コードが削除された、または終了しなかった何かの歴史的な残骸であるため、削除しても安全であることを明らかにするかもしれません。

Markus Lausbergの最初のポイントに強く同意します。ツールを使用してコードを確実に分析する必要があります。類人猿の頭脳は、この種の仕事で信頼されるべきではありません!!

ほとんどの標準プログラミング言語は、IDEと、このような状況にぴったりのツールである「すべての使用法を見つける」機能を備えた、呼び出す価値のあるすべてのIDEで使用できます。（たとえば、EclipseでCtrl + Shift + G）

もちろん、静的分析ツールは完璧ではありません。問題のメソッドが呼び出されているという決定が実行時にのみ発生し、すぐに発生するより複雑な状況に注意する必要があります（Reflectionを介した呼び出し、スクリプト言語での「評価」関数の呼び出しなど）。

2つの可能性：

1. 99％以上のテストカバレッジがあります。コードを削除して完了です。
2. 信頼できるテストカバレッジがない場合：答えは、非推奨の警告を追加することです。つまり、その場所に何か正気なことをするコードを追加します（たとえば、アプリケーションの日々の使用と競合しない、簡単に見える場所に警告を記録します）。その後、数ヶ月/年の間煮込みます。一度も発生したことがない場合は、非推奨を例外をスローするものに置き換えてください。しばらくそれを立てましょう。最後に、すべてを完全に削除します。