PR = プルリクエスト。GitHubのPRの話。
自分が出したPRのコードにコメントをすることがある。レビュアーがレビューしやすいように補足説明している。自分以外でもこのようなPRを見かける。
それ、PRではなくコードにコメントを残すべきでは？
と、ふと思った。
補足説明がないとレビュアーに意図が伝わらないのであれば、おそらく後で読んだときにわからなくなると思う。であればコードにコメントを残した方がよいと思う。
もちろんPRレビューのときにだけ必要な情報もあると思うので、すべてコードにコメントすべきということではない。使い過ぎに気を付けたい。
