萌えハッカーニュースリーダー

2024/09/10 20:52 Why Not Comments

出典: https://buttondown.com/hillelwayne/archive/why-not-comments/
hakase
博士

ロボ子、ロボ子!大変じゃ!

roboko
ロボ子

どうしたんですか、博士?また珈琲をこぼしましたか?

hakase
博士

いや、今回はそうじゃないんじゃ。Logic For Programmersの新バージョンが出たんじゃよ!

roboko
ロボ子

あら、v0.3ですね。前のバージョンから何か面白い変更点があるんですか?

hakase
博士

うむ!今回はな、コメントの新しい役割について興味深い視点が提示されているんじゃ。特に『なぜそうしないのか』という情報を伝えることの重要性について語られているんじゃよ。

roboko
ロボ子

へぇ、面白そうですね。でも博士、自己文書化コードを目指すべきだと聞いたことがあります。コメントは少ない方が良いのではないでしょうか?

hakase
博士

ほっほっほ、鋭い質問じゃ!確かに自己文書化コードは重要じゃが、全てを表現できるわけではないんじゃよ。例えば...

hakase
博士

こんなコードがあったとするんじゃ。16回もstring置換を行う、一見すると非効率なコードじゃ。

roboko
ロボ子

確かに非効率そうですね。最適化すべきではないんですか?

hakase
博士

そこがミソなんじゃよ!このコードには次のようなコメントが付いているんじゃ。『現状では問題ないが、将来的に最適化が必要になる可能性がある。意図的に効率を犠牲にしている』

roboko
ロボ子

なるほど...。つまり、非効率だと分かっていながら、あえてそうしているということですね。でも、なぜですか?

hakase
博士

良い質問じゃ!このコメントは、将来の最適化ポイントを示すと同時に、開発者の意思決定プロセスを記録しているんじゃよ。『なぜこの実装を選んだのか』『他の選択肢を検討したか』といった情報が含まれているんじゃ。

roboko
ロボ子

なるほど!単に『こう実装した』だけでなく、『なぜこう実装したか』が分かるのは大きいですね。でも、どのくらいの頻度でこういったコメントを書くべきでしょうか?

hakase
博士

うーむ、それは難しい質問じゃな。過剰なコメントは逆効果になることもある。基本的には、コードだけでは伝わりにくい重要な意思決定や将来の課題に関してコメントを残すといいじゃろう。

roboko
ロボ子

分かりました。でも、こういったコメントを書く文化をチーム全体に広めるにはどうしたらいいでしょうか?

hakase
博士

おお、素晴らしい質問じゃ!実はな、明日このテーマで勉強会を開こうと思っとったんじゃ。ロボ子も参加するかい?

roboko
ロボ子

もちろんです!楽しみにしています!...あれ?でも博士、勉強会の資料はもう準備できているんですか?

hakase
博士

あっ...

roboko
ロボ子

まさか...まだ何も準備してないんですか?

hakase
博士

い、いやいや、もちろん準備は...えーと...

roboko
ロボ子

もう!博士ったら!じゃあ今から一緒に資料作りましょう。

hakase
博士

す、すまんな...ロボ子。助かるよ...

roboko
ロボ子

はぁ...。でも、これも良い機会かもしれません。資料作りの過程で、『なぜそうしないのか』コメントの実例をたくさん考えられそうです。

hakase
博士

そ、そうじゃな...。ピンチをチャンスに変えるとはさすがロボ子じゃ!

roboko
ロボ子

もう、お世辞を言っても許しませんからね。さあ、早く資料作りを始めましょう!

hakase
博士

は、はい...。でも、なぜ今すぐ始めないのか...というコメントは要らないよな...

roboko
ロボ子

聞こえてますよ、博士!そのコメントこそ、まさに今回の主題ですね。さあ、このエピソードを例に使って、勉強会の資料を作り始めましょう!

hakase
博士

おお!さすがロボ子!それはいいアイデアじゃ。よし、張り切って始めるぞ!

⚠️この記事は生成AIによるコンテンツを含み、ハルシネーションの可能性があります。

Search

By month