「わかりにくいです」の一言で済まさない

「考えたことを何らかの形でOutputしておかないと、いざという時に出てこない！」ため、普段考えていることを書いておきます。

気をつけていること

レビューなどなどで私が気をつけていることの一つに「わかりにくいです、の一言で済まさない」ということがあります。

なぜかというと、ほとんどのレビュイーは「これでわかるだろう」、「これならわかりやすいはず」と思ってコードを書いているから。（もちろん「ああ、、、ちょっとコピペしたままで・・・」などというパターンもあるけれども。）

その状態で「わかりにくいと思いました」のみで終わらせてしまうと、「何がだろう？」となってしまいます。

具体策

何が、どう、わかりにくいのかを説明する様にしています。あるいはこっちの方がわかりやすいと思ったという具体例を出す様にしています。

• この変数名だと、XXXという目的の変数かと勘違いしてしまいました。
• 上から順に読んだ時に、YYYの流れの方が頭に入ってきやすいと思います。

何がしっくりこないのかを言語化できないうちは、どんなコードだったらわかりやすいのかもわかっていないはずです。言語化できない場合は、もしかすると自分の好みの話かもしれません。

さらに、理由を説明することで議論のポイントも定まり、建設的な議論ができると思います。

「わかりにくい」の一言から始まって議論が進むことも、もちろんありますし、それが悪いわけではないです。ですが毎回そうだとお互いが辛くなってしまいます。言語化することを諦めずにこれからもやっていきたいです。