Skip to content

Instantly share code, notes, and snippets.

@funwarioisii
Last active May 17, 2023 05:03
Show Gist options
  • Save funwarioisii/7e143a456df66c7255d8a0bae7914d1b to your computer and use it in GitHub Desktop.
Save funwarioisii/7e143a456df66c7255d8a0bae7914d1b to your computer and use it in GitHub Desktop.

Git で管理してるからコメントアウトじゃなくて消せるし onetime/*.rb も消せる

弊社はコード削除する時、コメントアウトしてるのですが、Gitを導入してる現場って、コードを削除する時、普通に消してたりするんですかね?

— マリン🌺ソフトウェアエンジニア (@Mariacron110) May 15, 2023
<script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>

というのを見て、「Git で管理してるならコメントアウトせずに消そうな」と思ったけど、一度だけ実行されるという名目で作られたバッチファイルが onetime/ というディレクトリに置かれているが、また使うかもと思って消せていない事に気づいた。

もとのツイートではコメントアウトで残す理由や背景が書かれていないため、自分が思った感想とは関係ないかもしれないけど、感想を書いてみる。

そもそも自分が onetime/ (実際は rails を使っていて、 app/jobs/onetime/)というディレクトリにファイルを作成するときは

  • app/jobs に置くほど定期的に実行する予定がない
  • irb で実行するにはコード量が多く、インタラクティブにやりたくない
  • (一度だけ実行する予定がある)

というもの。

そして、残してしまう理由は

  • まだまだ同じ作業するかもしれない
  • 時間をあけて同じ作業をしたくなるかもしれない
    • 再度実装するときに参考になるかもしれない
    • 一回作業を離れるとドメイン知識が抜けて、思い出すのが大変
  • そもそも消すということを忘れている。忘れてないけど面倒くさい。

というもの。

消すというのはやっぱりコストが高いし不安も大きいけど、それこそ技術的負債なので消していきたい。 消すためにはどうしたらいいんだろう?

「掃除をバックログアイテム・タスクとして積む」という選択肢しかないのかなぁ。 散らかってるから作業が進まないというコスト感というかスリップダメージは、なかなか説明し難いけど技術者として勘でエイヤで入れていくしかないんだろうか。

@funwarioisii
Copy link
Author

そういえば irb みたいな interactive なやつじゃなくって、エディタで書くと copilot とかの恩恵にあずかれるというのがあるな

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment