2020-05-31

ソースコード中のコメントアウトしたコードを消すべきか

git とか使ってるなら戻せるんだから消しておけ が主流だと思う

自分も以前はそう思ってた


だけど、過去バージョンから戻せるのはそれを知ってる人、基本的に作ってその修正をした人なんだよね

引き継ぎで渡されたものとか過去に何があったか知らないし、戻すだけで良くても戻すものがあることを知らない

引き継いだときに何千とかあるコミット全部を確認なんてするわけないし、コミットがきれいにまとめられてなくてコメントも「修正」くらいしか書いてないのだと見る価値いから全くと言っていいほど見ない


そういうことを考えるとコード中に残した上でコメントとして「〇〇するための機能、✖✖ならこのコメントアウトを解除すればいい」みたいなのが残ってる方が助かる

コメントアウト部分はメンテされてないかそのままでは動かないかもしれないけど、他人が作ってどこをどう修正すればいいかがわかりづらいものだと、なにもないよりは参考になるものがあってそれを少し直す方が楽だし


バージョン管理してるなら消すべき とは思わない派にしました

  • 消すと動かなくなる呪いをかけておいた

    • コメント消すと動かないようなもの作れるんかな 最後にバックスラッシュとかは有名すぎるし・・・ // ⇩消すと動かない // 消すと動かなくなるコード みたいなの書いといてみたい...

記事への反応(ブックマークコメント)

ログイン ユーザー登録
ようこそ ゲスト さん