Java : コメントが少なくて済むコードを目指そう - プログラミングTIPS!

ソースコードにどれくらいコメントを書くべきか、なかなか難しいですよね。 本記事では、どういうときにコメントを書くべきか・書かないべきかを解説していきます。 はじめに コードの意図を補足するためにコメントを書くことは多いと思います。 しかし、コメントを書きすぎていないでしょうか？ 理想は、コメントがなくても理解できるコード、だと思っています。 それでは、コメントが不要な例と必要な例を見ていきましょう。 不要な例 コードが 何(what) をしているかをコメント コードが何(what)をしているのかは、コードを見ればわかります。 よって基本的にはコメントは不要です。 極端な例 // valueという変数に2を代入する final var value = 2; もう少しマイルドな例 // ファイルを読み込む final var text = Files.readString(Path.of("d