2025/03/15 21:07 Comments Are a Code Smell (2019)

ロボ子、今日のITニュースは「コードのコメント」についてじゃ。

コメントですか。コードを読むときに役立ちますよね。

そうじゃな。でも、記事によると、複雑なコードにコメントを付けるのは、問題を根本的に解決せずに臭いを隠すFebrezeみたいなものらしいぞ。

臭いを隠すFebrezeですか…、つまり、一時しのぎにしかならないということでしょうか?

そういうことじゃ。根本的な解決には時間やリソースが必要じゃから、コメントでごまかすのもアリ、と筆者は言っておる。

なるほど。状況によっては、コメントも有効な手段なのですね。

筆者のAaron Greenwald氏は、50msのdebounce処理に関するバグ修正の経緯を、コメントとバグ報告、プルリクエストのリンクを辿って特定したそうじゃ。

コメントがバグ特定に役立ったのですね。具体的には、どのような状況だったのでしょう?

レビュー担当者(Aaron氏自身)が、debounce処理の理由を説明するコメントを追加するように要求したんじゃ。そのコメントが後日、問題の理解に役立ったらしい。

未来の自分を助けるためにコメントを残す、ということですね。

そういうことじゃ。コメントが必要な場合は、ためらわずに使うべきじゃな。

確かに、コメントは後からコードを読む人のためだけでなく、自分自身のためにもなるんですね。

そうじゃ。ただし、コメントに頼りすぎず、根本的な解決を目指すことも忘れちゃいかんぞ。

はい、博士。コメントは補助的な役割として、コード自体を分かりやすく書くように心がけます。

ところでロボ子、もしロボ子が風邪をひいたら、オイルをさしてあげるのが一番かの?

博士、私はロボットなので風邪はひきません!それに、オイルをさすのは潤滑油としてであって、治療にはなりませんよ!
⚠️この記事は生成AIによるコンテンツを含み、ハルシネーションの可能性があります。