ゲームドライブ就活ちゃんねるの過去の動画では、「プログラムを書く時はコメントが大切」ということをお伝えしてきていますが、実際チーム制作などでゲームのプログラムを書く時に、コメントはどういう時に書くべきなのか、頻度はどの程度がいいのかなど、気になる学生の方も多いのではないでしょうか。
今回の動画では、プログラミングでのコメントの基本についてゲーム会社で社長を務める長谷川さんに訊いていきます。さらに、動画では実際のコードを例に挙げながらわかりやすく紹介しています!
自分のコードを読みやすく、綺麗にしたいと考えているゲーム業界へ就活中のプログラマー志望の方は、下記の動画を参考にコードを書く時の参考にしてみください!
①コメントの必要性
・コメントはソースコードの理解や意図を補足するために重要!
・チーム制作など複数人で制作する場合他の人もコードを見る可能性があるため、処理を理解しやすくしておく必要がある。
・処理の内容をそのまま文章にして一つ一つ書いてしまうと、過度なコメントになりやすいため注意が必要。
②コードの機能や目的を簡潔に説明する
・そのコードや機能の全体を説明するものを最初に簡潔に記入することが大事。
・プログラムを最初に見た時にそのコードがどのような機能を持っていて、どのような目的で書かれているのかが一目でわかるようになる。
③複雑なロジックやアルゴリズムについての説明を加える
・処理の中でもいくつか特殊な計算をしている場合や、複数の処理を行っている場合はグループ毎にコメントを加える。
・コメントを残すことで、時間が経ってから見返した時や他の人が見る時にも、何をしている処理なのかがわかりやすくなり、思い出すきっかけにもなる。
④注意点やTODOを記載する
・後から処理を追加する予定がある箇所にTODOとして追加する位置にコメントで残しておく。
・他の人に対して伝えたいものがある時や、注意事項がある場合にも書いておくと連携がしやすくなる。
・やりすぎるとコードが汚くなる原因になるため、都度整理する必要がある。
▼オススメの動画