ポエミーな記事です。
レビュー
Web 系の企業でコードを書くお仕事をしていると、同僚のコードレビューを頻繁にしますよね。
それで、レビュー時に「あ、このコード良いなぁ」と思う事って、頻繁にありますよね。
例えば言語機能を見事に使いこなしたコード。
例えばドメインを美しく解りやすく表現したコード。
例えば上手に構造化された頑強で変更しやすいコード。
例えば分かりにくい例外的事象に正しく対処したコード。
その、「あ、このコード良いなぁ」という気持ち、 ちゃんと表現しましょう 。
心の中で思っているだけでは伝わらないです。
褒める
GitHub を使ってコード管理、レビューを行っているのであれば、良いと思った部分のコードにその旨をコメントしましょう。
xxx 関数を使って綺麗に処理している :+1:
xxx と ooo をきちんと分けているのは good
xxx の処理を切り出して private method にしているのとても分かりやすい!
xxx の場合にちゃんと対処している :heart:
何故良いと思ったのか、どう良いと思ったのか、短く説明するとより好印象でしょうが、 や
だけでも問題ないと思います。
レビューの社内ルールでコメントに指摘以外を残せない、というのであれば、社内チャットで「ここ良かったよ」と伝えるのもいいでしょう。
とにかく、ちゃんと言葉に出して相手に伝える事が肝要です。
まとめ
レビューはコードの品質を維持するための大切な作業ですが、とはいえ、間違った点良くない点の指摘ばかりを受けていると気分も盛り上がらないでしょう。
もちろん問題点の指摘は大切です。しかし、そういう改善点と同じくらい、良い点見事な点もあるはずなのです。
そういう部分を、きちんと言葉にして称賛する事で、コードを書く事の喜びを少しでも増やす事ができます。
副次的な効果として、チーム内でのコードの指針を帰納的に構築する事ができる、という面が挙げられるかもしれません。
望ましいコードとはどのようなコードなのか、実例を積み上げる事も、コードの品質向上に繋がるはずだからです。
何でこんな記事を書いたのか
上で挙げたような事、 自分でもできてないなぁ と常々思っていたので、反省と自戒の為に書きました。