わかりやすい文章、わかりやすいコード

私の本業はソフトウェアエンジニアである。いわゆる「プログラミング」という作業を行う。プログラミングとは、プログラミング言語を使って、コンピューターやスマートフォンにさせたい処理をテキストファイルに記述する。テキストファイルに記述された文章をコード、ソースコードと呼ぶ。

（話をかなり単純化すると）システムやアプリは書かれたコードの通りに動く。よって、コードの書き方が間違っているとシステムやアプリの挙動もおかしくなる。

システムやアプリを作っていくプロセスの中には、上記のようなプログラミングの他にもさまざまな作業があり、その一つが「コードレビュー」だ。

コードレビューとは書かれたコードをチェックする作業だ。コードを書いた人とは別の人がチェックする。

コードレビューでチェックすることはチームによっても異なる。多くの場合は、処理に間違いがないか、適切な命名がなされているか、他と統一性がある書き方になっているか、複雑すぎる部分がないか、というようなことを実際に書かれたコードを読んでチェックする。

処理の正誤だけではなく、「読んだときにわかりやすいか」という点もチェックするのだ。プログラミングでは、実はコードを書くよりもコードを読む時間のほうが長いと言われている。

とある機能の動きを変えたい、バグを修正したい、と思ったとき。コードを修正する前に、まずはコードを読んで理解するところから始まる。コードを読んで、どのように修正すればいいのか、気をつけることはあるか、影響範囲はどの程度になるのか、ということを理解して、初めてコード自体を修正し始める。

自分以外の人が書いたコードに手を入れるということは頻繁に起こる。さらに昨日の自分や明日の自分は自分ではない。びっくりするほど自分の書いたコードを忘れている。2ヶ月前に書いたコードなんてかけらも覚えていなかったりする。

将来の自分も含めた、自分以外の人も読んで理解しやすいコードを書く必要があるのだ。そのため、コードレビューでは「ここの処理が複雑なのでコードコメントを入れたほうが後々のために良いと思います」「この名前だと×××と勘違いする可能性があるので、〇〇にするのはどうでしょう？」といったフィードバックが並ぶこともある。

※コードコメント・・・コード中に書くことができるコードの説明文。プログラムの実行に影響は与えず、日本語を使って書くことができる。

「文章を書く」ということを考えれば考えるほど、「コードを書く」ということとの共通点がたくさんある。確かにコードも文章である。もちろん日本語で書く文章のわかりやすさとコードのわかりやすさの中身は違うが、どちらも「わかりやすさ」は大切である。

この仕事を始めて10年が経っている。それだけコードレビューをしてきたし、受けてもきた。これだけやっても「わかりやすさ」という点はどこまで行ってもゴールがないなと思う。しかし、「わかりやすさ」にこだわるのはとても楽しい。これからも「よりわかりやすい」を目指していきたい。