その説明、コードコメントに書く?コミットメッセージに書く?プルリクエストに書く? by おかしょい/岡田 正平

PHPerKaigi 2023
LT(5分)

その説明、コードコメントに書く?コミットメッセージに書く?プルリクエストに書く?

okashoi おかしょい/岡田 正平 okashoi
10

先輩「この実装はどうしてこうなっているの?」
自分「ここは〇〇という理由でこうしています!」
先輩「了解です、その説明はコードコメントに書いておくとよいので追記お願いします~」
コードレビューを受けているとき、こんな経験はありませんか?

コードで表現できないことを説明したいとき、それを書く場所の候補はコードコメント、コミットメッセージ、プルリクエスト(説明欄やコメント)と多岐に渡ります。
「どこに書けばいいのかわからない!」そんなときの指針となるお話をします。