EC研修一ヶ月の思い

こんにちは、
研修を頑張っているふみです。

部門研修が始まって一か月半が経ちました。
コードを読むのはなかなか大変ですが、意味が分かったらすごく嬉しいです。
その中で、一番助かったのが「コメント」です。
コメントがないとコードを理解するのに倍以上の時間がかかるかもしれません。
今回は自分が感じたコメントの重要性をシェアしたいです。

感じた重要性

コメントがあることで、全体の構造が理解しやすくなります！
最初は何も知らない状態でソースコードを見た時、全くわからなかったこともありましたが、
コメントのおかげで、
徐々にこのソースコードが何のために書かれたものなのかが理解できるようになりました。

コードを読みやすくすることで、時間を節約できます！
ソースコードの処理が説明されているので、理解が早くなると思いました。

また修正・変更した部分がわかるのも大きな利点です。

未来の自分のため？

自分もコメントを付けることを始めました。
最初は慣れず、忘れてしまったこともたくさんあります。
コメントを書くのは時間がかかるので、時々面倒くさいと思うこともありました。
しかし、1か月後に改めて自分の書いたコードを見た時、コメントのありがたみを感じました。

時間が経つと、自分で書いたコードでも意味を忘れてしまうことがあります。
だから、自分で書いたコメントを見ると、当時自分がどのように考えたかが分かるようになります。

コメントとは別で、コードを書く際、時々メモを取ることがあります。
これは将来同じ処理を再度見ることになった時などに、とても役立ちます。

良い習慣を身に着けていく

コメントの重要性はここまで説明してきましたが、
これは自分のみならず、他の誰かのためにもなります。
チーム開発のメンバーやソースコードを保守する人に情報を伝えるためにも、
しっかりとコメントを書く必要があると思います。