2024-11-15

コメント重要

まず言っておきたいのは、コメントってやっぱり大切だってこと。

コードを書いた人の意図を後から見た人が理解できるようにするためのものだし、未来自分が「あれ、これ何書いたっけ?」と迷うのを防ぐためにもコメントは欠かせない。

でもうちの会社にいる“バリバリできる人”、仮にSさんとしておきましょう。

このSさんそもそもプログラムスキルが超ハイレベルで、コードをめちゃくちゃ書ける人。

みんなが「あれどう書くんだっけ?」ってなるような複雑なロジックサクサク書けるし、妙なバグも即座に見抜く。もう尊敬しかない。

で、Sさんコードは、当然コメントバッチリ入っているわけですよ。ただね…これが実に困った問題なんだけど、そのコメント意味がわからない。

何が書いてあるのかが普通コメント以上に謎。

だってSさん説明って、どこか抽象的だったり、ちょっと暗喩暗号?)染みてるんです。

言葉としては正しいし、ちゃんと書いてくれてるんだけど、どうも頭に入ってこない。

たとえば「このループは不変量を維持するための役割を果たす」とか、やたらと専門用語が並ぶ感じ。

で、読んだ結果「何をどうしてるんだっけ?」と逆に混乱してしまう。

それで、しまいには「Sさんコメント意味がわからいから、誰かもう少しわかりやす説明を足してくれませんか?」っていうリクエストが社内で上がるようになった。

なんというか、コメントに対するコメント必要になってきた。

この“コメントに対するコメント”という新しい文化が生まれつつある。

これがまた曲者で、しまいにはコメントの数が倍増し始めた。

Sさんが「ここは変数定義です」と書くと、誰かが「この変数定義がなぜ必要かについて補足します」とか、「ここでの不変量とは何か解説します」とか言い出すわけですよ。

Sさんが「このアーキテクチャがスケーラビティを保つためのものである」と書けば、「スケーラビティの具体的な定義についてもここにメモしておきます」とか。まるで辞書注釈がついていくみたいに、コメントがどんどん増えていく。

こうなると、なんというか「天才思考の跡をたどる」って感じになってきて、普通エンジニアとしては大変なんよ。

Sさんとしては、きっとわかりやすく書いてるつもりなんでしょうが、僕たちからするとSさんコメントを読み解くためにさらに別のコメントをつけていく状況。

こうして、コメントの数だけが増え、肝心のコードがどんどん見づらくなっていく。

なんだか本末転倒な気もするけど、仕方ない…。

コメントがないとわからないし、でもコメントがあってもわからない。

いやー、天才ってすごい。

記事への反応(ブックマークコメント)

ログイン ユーザー登録
ようこそ ゲスト さん