Contents
はじめに
皆さんは不要になったコードはどうしていますでしょうか？
・削除する
・後で使うかもしれないからコメントアウトして残す。
本記事では不要なコメントアウトは削除することをおすすめするのと、同時に仕組み、ルールについても記載いたします。
概要
現場で仕事をしていると、出来上がったソースコードを、なんらかの理由で修正くることが発生します。
・仕様が変わった。
・不具合の対応
・リファクタリング
理由は様々あると思います。
上記のコードの修正により、当然不要になるコードも出てきます。
・せっかく作ったのに削除するのはもったいない。
・また後で使うから残しておこう。
なんて気持ちが生まれるかもしれません。
しかし、不要になったコードをコメントアウトで残すことはおすすめしません。
代わりにバージョン管理システムの履歴として残すのが正解です。
さて、ここで問題が発生しました。
『うちのプロジェクトバージョン管理ツール(Git)を導入してないので、バージョン管理できません。』
この問題は以前から検知してた問題だったのですが、諸々の都合があり、バージョン管理ツール(Git)は導入できませんでした。
バージョン管理システムがないなら、仕方がないか。とそのときはコメントを残すことにしました。
結果
不要なコードが残っていることにより、可読性が下がってしまった。
・調査、改修、レビューする時の各工程で不要なソースがノイズになり、ソースを読む効率が著しく下がりました。
・Grepした結果、コメントアウトしたコードが引っかかってノイズになる。
特に不具合の調査をする際は、実際に動いているコードだけ理解したいので、不要なコードがノイズになり、余計な手間がかかってしまいました。
また、不要なソースコメントがあることにより、余計なスクロールが発生する。
結果、生産性が低くなるという結果になりました。
仕組みを変えてみた。
これは、早急に是正しないといけないと思い、
そもそもなんでコメントアウトしているんだっけ？というのを聞いてみて、やはりバージョン管理ツール(Git)が導入できないからだという結論にいたりました。
そこで、あれ？Git導入できないのは無理だけど、他の手を使えばいいのでは？ということに気付き。
以下のルールを追加して運用してみました。
①開発前に資源全量のバックアップを取る。
②開発メンバーが個別の案件を開発する際は必ず改修前後のソースを取得して成果物とする。
まとめ
まだまだ改善の余地がありますが、不要になったコードのコメントアウトを許してしまうと、
そこら中にコメントアウトのコードが増殖してしまい、コードの可読性が下がってしまいます。
なので、リーダーの方は不要なコメントアウトを許してはいけない。
エンジニアの方はまずはコメント以外で表現する方法を考え、どうしてもコメントでしか表現できないものをコメントとして残すようにする。
そうすることで、ソースコードがとても読みやすいものになります。ress. This is your first post. Edit or delete it, then start writing!
