web-dev-qa-db-ja.com

使用していないコードをコメントするか、ソリューションから削除する必要がありますか?

私はストーリーで作業しており、最後にUIから何かを非表示にするように求められました。次のリリースでそれを使用します。

  • 削除するかコメントするか

  • この部分に関連するものをコードから削除またはコメントするか、それが何にも影響しない場合はそのままにしておきます。

2
Ahmed Ragheb

クリーンな作業を重視する場合は、コードをコメントアウトするのではなく(これは非常に短期的には十分な方法です。つまり、数週間以内に話している場合)、ソース管理システムを使用することをお勧めします( Git、Mercurial、Subversionなど)代わりに:

機能のコード、およびその機能に特に関連していて他のコードでは使用されていないものはすべて、別の機能ブランチ(つまり、現在の開発ブランチの分岐)に移動します。メインの開発ブランチでコードが完全に削除されていることを確認してください。このようにして、機能を再度アクティブにするために必要なことは、機能ブランチをメインの開発ブランチにマージすることだけです。 notで行う必要があるのは、コメントアウトを行ごとに元に戻すことです(どこかでコメントを外すのを忘れている可能性があります)。

少し作業が増えるかもしれませんが、コードをコメント化するよりもずっとクリーンな作業方法です。コメントアウトされたコードは、時間の経過とともに蓄積する傾向があり、(以前の期待に反して)多くの場合、再びコメントが外されることはありません。そのため、コメントアウトされたコードの一部に、なぜコメントアウトされたのかを明示したドキュメントがない限り、またコメントを外す必要がある場合、つまずくたびにコードベースからコメントアウトされたコードを削除する傾向があります。

同じ理由で、機能の「トリガー」コードを無効化/削除するだけでなく、それだけに関連する他のすべてのコードを無効にする/削除することをお勧めします(たとえ、コア機能コード)。なぜなら、もしあなたが最終的にしないでください機能を次のリリースに入れると、依存するコードを忘れてしまうかもしれないからです。したがって、「コア」/トリガー機能コードと同じように扱います。

11
stakx

これが私がすることです:

  • 何かする前に、コードがソース管理にチェックインされていることを確認します。そうすれば、必要なときにいつでも後で回復できます。

  • 原則として、コードベースをできるだけクリーンに保つために、不要になったコードを削除する必要があります。そのため、「近い将来」にコードが再利用されることを期待しない場合は、コードを削除してください。

  • ただし、この場合、コードが次のリリースで使用されることを期待する十分な理由があります。したがって、コメントアウトする(何をしているのかを説明するコメント付き)がおそらく最善の策です。結局それを使用していないことがわかった場合は、後で削除できます。

4
Kramii

または、コードが自己完結型であり、この対策が一時的なものである場合は、ifステートメント内にコードをラップし、ブールフラグを設定してコードブロックを無効にすることで回避できます。これが良い習慣かどうか...

4
Moobie

SVN、Git、Mercurialなどのバージョン管理を使用している場合は、それを別のブランチに配置して、リリース/メインブランチから削除できます。リリースの準備ができたら、ブランチをリリースブランチにマージできます。

バージョン管理を使用しない場合は、コメントで記述しても問題ありません。ただし、コメントに何かを入れると、忘れがちになるので、まだバージョン管理を行っていない場合は、バージョン管理の使用を開始することをお勧めします。

2
PJvG