はてなブックマーク

はじめに 現在スクール課題でRailsでSNS風アプリケーションを開発しています。 開発を始めた当初、自分は「コメントは多ければ多いほど親切」くらいに考えていました。しかし、他の人が書いたコードを読んだり、有名な技術書を読んだりする中で、コメントにはコードの価値を大きく高める「良いコメント」と、むしろ価値を下げてしまう「悪いコメント」があることに気づきました。 今回は、自省と学びを元に、保守性・可読性を高めるコメントの書き方について、その原則をまとめてみました。 コメントの基本方針：「What」より「Why」 優れたコメントの原則は、コードを読めばわかるWhat（何をしているか）ではなく、コードだけではわからないWhy（なぜそうしているか）を説明することです。 コードは user.name = "Taro" のように、「何をしているか」を語ります。しかし、「なぜTaroという名前を代入する