はじめに 今までコードの書き方の勉強には力を入れてきました。 ですが、コメントに対してはあまり意識せずにコーディングしてきました。 実際、コメントを書くのは面倒だし、書くことにメリットが見出せていませんでした。 理由は明確で、コメントを書くことのメリットや目的、自分の中での方針を決めるような時間を取っていなかったことが原因だと思います。 書く書かないなどいろんな流派があって答えはないと思いますが、 自分の中で理由とセットで意見を持つことは重要だと思うので、さっそくコメントにどう向きあうか考えてみます。 コメントを書くことのメリット・デメリット まずはコメントを書くことのメリット・デメリットについて洗い出してみます。 こんな重要なメリットやデメリットもあるよ!!などありましたらコメント欄でご指摘いただけますと幸いです。 メリット コードを読まなくてもメソッドの使い方などがわかる 初めてコード
![【まとめ】コードのコメントに対する自分の指針を決める - Qiita](https://cdn-ak-scissors.b.st-hatena.com/image/square/3475ce8e6a5e9c9514d501bc19add6ba84a0845e/height=288;version=1;width=512/https%3A%2F%2Fqiita-user-contents.imgix.net%2Fhttps%253A%252F%252Fcdn.qiita.com%252Fassets%252Fpublic%252Farticle-ogp-background-9f5428127621718a910c8b63951390ad.png%3Fixlib%3Drb-4.0.0%26w%3D1200%26mark64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTkxNiZoPTMzNiZ0eHQ9JUUzJTgwJTkwJUUzJTgxJUJFJUUzJTgxJUE4JUUzJTgyJTgxJUUzJTgwJTkxJUUzJTgyJUIzJUUzJTgzJUJDJUUzJTgzJTg5JUUzJTgxJUFFJUUzJTgyJUIzJUUzJTgzJUExJUUzJTgzJUIzJUUzJTgzJTg4JUUzJTgxJUFCJUU1JUFGJUJFJUUzJTgxJTk5JUUzJTgyJThCJUU4JTg3JUFBJUU1JTg4JTg2JUUzJTgxJUFFJUU2JThDJTg3JUU5JTg3JTlEJUUzJTgyJTkyJUU2JUIxJUJBJUUzJTgyJTgxJUUzJTgyJThCJnR4dC1jb2xvcj0lMjMyMTIxMjEmdHh0LWZvbnQ9SGlyYWdpbm8lMjBTYW5zJTIwVzYmdHh0LXNpemU9NTYmdHh0LWNsaXA9ZWxsaXBzaXMmdHh0LWFsaWduPWxlZnQlMkN0b3Amcz0zMjI4MmVmOGM2NWRmN2YzM2M5ZjgwODQ1NzhkYTkzZg%26mark-x%3D142%26mark-y%3D112%26blend64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTYxNiZ0eHQ9JTQweW9zaGlub3JpX2hpc2FrYXdhJnR4dC1jb2xvcj0lMjMyMTIxMjEmdHh0LWZvbnQ9SGlyYWdpbm8lMjBTYW5zJTIwVzYmdHh0LXNpemU9MzYmdHh0LWFsaWduPWxlZnQlMkN0b3Amcz00NDY5MjRlM2UzMmNkMjIwMmE0MDNiNzM0YzZjNTBhNg%26blend-x%3D142%26blend-y%3D491%26blend-mode%3Dnormal%26s%3D635827dd7dd8cae701dad5a31edc002b)