ソースコードのコメント文を日本語で書くようにしたら品質が上がった

自分はこれまで、プログラムを書く際にそのコード内に記述するコメント文や、コミットする際のメッセージを基本的に英語で書くようにしていた。その理由としては、

・ソースコードを書く際は基本的に英文であることが多いので、キーボード入力上における日英の切り替えの手間を省くことができるため
・自分の英語力が衰えないようにするための鍛錬のひとつとして

といった点が挙げられる。また、コメント文を英語で書いてしまうとチーム開発においてボトルネックになるのではないか、と思われるかもしれないが、基本的に私に開発スタイルにおいては1人ないしはごく少数のエンジニアチームで進めることがほとんどであり、チームで進める際には予めコメントの記法について確認をとった上で進めるようにしていた。

そんな中、1年ほど前から少し大きめのプロジェクトに参画し、その仕事においては日本語でのコメント及びコミット文を書くスタイルで進めるかたちとなった。最初はコメント文における言語の差異についてそれほど気にしていなかったのだが、結果としてこれが自分のソースコードの品質に影響を与えることとなった。

まず、当然の話ではあるがコメント文を母国語で書くということは、自分の考えている内容の情報量をほとんど削ぎ落とすことなくそこに残すことができる。無意識ではあったが、英語で書いていた際は自分の英語力で表現できる範囲に落とし込むため一定程度情報量を削ぎ落としていたのである。また、コメント文を日本語にすることで、単純な文章量も以前より増えた。

コメント文を丁寧に書くようになった後、その次に起きた副次的な作用として、コード自体も以前より丁寧に書くようになった。この点においてはかなり僕自身の性格によるところかもしれないし、いわゆる「机の上をきれいした方が仕事が捗る」といったレベルの話かもしれない。ただ、事実として自分の中では目に見えてコードの品質が以前よりも上がったため、コメント文の言語を変えたことがここまで影響してくるものかと驚かされた。

今回の体験から得られる気づきは主に2点あると考えている。1点目は、コメント文の情報量や書き心地を過小評価していたこと。2点目は母国語と第二言語の出力品質の差を過小評価していたことである。とはいえ後者については当然のことでもあり、品質の差を気にするあまり使う機会を渋っていては自分の第二言語力が一向に伸びないためバランス感覚は必要であるが、特に情報量やニュアンスが重要であると思われる場面においては、やはり母国語に頼るべきだと気付かされた次第。

つぎの日 2pxのドット

ランダムな日

まえの日 今年も大変お世話になりました。

ランダムな日

loading loading