効果的なコードコメントの書き方は？
コードの品質を高めるためにも、読み手にとってわかりやすいコードが書けるよう努めています。しかし、完璧な自己記述的コードを書くのは難しいと感じることもあり、必要な場所でのコメントは避けては通れないと感じています。
コメントが多ければいいというわけではないと思っていますが、それでも、伝えきれない意図や背景をきちんとコメントで残すことは重要だと考えています。特に、動作そのものを説明するのではなく、そのコードがなぜそのように書かれているのかの意図をコメントで示すと、後からそのコードを読む人が理解しやすくなると考えています。
また、多くの組織ではコーディング規約が設定されており、コメントの書き方についても指示がある場合が多いです。そういった場合は、個人の是非を問わず規約に従うことが大切だと思っています。
そこで、効果的なコードコメントの書き方やポイントについて、皆さんの経験や意見を教えていただきたいです。具体的な例や実践しているコメントのルールなども知りたいです。よろしくお願いします。
コメントが多ければいいというわけではないと思っていますが、それでも、伝えきれない意図や背景をきちんとコメントで残すことは重要だと考えています。特に、動作そのものを説明するのではなく、そのコードがなぜそのように書かれているのかの意図をコメントで示すと、後からそのコードを読む人が理解しやすくなると考えています。
また、多くの組織ではコーディング規約が設定されており、コメントの書き方についても指示がある場合が多いです。そういった場合は、個人の是非を問わず規約に従うことが大切だと思っています。
そこで、効果的なコードコメントの書き方やポイントについて、皆さんの経験や意見を教えていただきたいです。具体的な例や実践しているコメントのルールなども知りたいです。よろしくお願いします。
1年前
view数 86
回答を投稿して企業にアピールしましょう！
Q&Aで投稿された回答は、
企業側に表示されるプロフィールにも投稿履歴として表示されます。
Offersにログイン・新規登録して、気になるテーマやトピックを話してみよう！
＼回答があります！／
Shoichi Namba
エンジニア
1年前
後で見たときに、「なんだろこれ、消してもだいじょうぶそうだな」と見えそうなところにはちゃんと書いておきます。
またプルリクエストなどのときに「これはこういう理由があり追記しているコードです」のような、説明しないとわからない部分なども書くべきところである可能性のあるヒントになるかと思います。view数 21