若手・未経験エンジニアがコードレビューで指摘されがちなポイント

Summary

福本さんが実際に現場で経験したコードレビューでの指摘ポイントについて語りました。特に新入社員や若手エンジニアがよく誤るマジックナンバーの使用、環境変数やAPIキーの漏洩、アクティブレコードの使い方などが指摘されています。また、コードの読みやすさやリファクタリングの重要性、コミットログの荒さなどにも触れています。このトークは、エンジニアとして成長するために必要なポイントを押さえ、コードレビューを受ける際の注意点を理解するのに役立つと思われます。

Takeaways

• 🎯 未経験のエンジニアや若手エンジニアがコードレビューで指摘されがちなポイントについて解説します。
• 🔢 マジックナンバーを避けるために、定数を使用して数字の意味を明示しましょう。
• 🆔 IDを直接使用せず、レコメンドタイプなどの識別子を使ってコードの可読性を向上させましょう。
• 🔒 環境変数やAPIキーなどの機密情報はソースコードに直接書かず、セッティングスやクレデンシャルズを使用して管理しましょう。
• 🔗 アクティブレコードのリレーションを適切に利用し、パフォーマンスを向上させましょう。
• 📝 コントローラーに処理を集約しすぎないように注意し、モデルを適切に活用しましょう。
• 🔄 長いメソッドはリファクタリングして短く簡潔に保ち、コードの見やすさを維持しましょう。
• ⚠️ ピントが通っていないコードやテストが書かれていないコードはレビューで指摘されやすいです。
• 📜 コミットログやコメントを丁寧に書き、他の開発者が理解しやすいように心掛けましょう。
• 👥 開発はチームで行うものであり、誰が見てもわかりやすいコードとコメントを書くことが重要です。

Q & A

コードレビューでよく指摘されるポイントは何ですか？

コードレビューでよく指摘されるポイントとしては、マジックナンバーの使用、環境変数やAPIキーなどの機密情報の漏洩、リレーションが使えないActiveRecordのコードなどがあります。

マジックナンバーとは何で、なぜ問題となりますか？

マジックナンバーとは、プログラム中に直接数字を書いた場合を指します。これは数字の意味が分かりづらいため、コードの可読性や保守性が低下します。

環境変数やAPIキーをソースコードに直接書かないようにするにはどうすれば良いですか？

環境変数を使用するか、Gitなどのバージョン管理システムに情報をプッシュしないようにすることで、機密情報を漏洩しないようにすることができます。

ActiveRecordのリレーションを使用しない場合のデメリットは何ですか？

リレーションを使用しない場合、SQLが見づらくなり、パフォーマンスが低下するなどのデメリットがあります。

コードレビューを受ける前に何をチェックしておくべきですか？

コードレビューを受ける前に、マジックナンバーの使用や環境変数やAPIキーの漏洩、リレーションの使用などをチェックしておくべきです。

コードレビューで指摘された際、どのように対応するべきですか？

コードレビューで指摘された際は、指摘された点を真摯に受け止め、修正するように努めることが重要です。

コードを書く際に意識すべき開発のお作法とは何ですか？

コードを書く際には、誰が見てもわかりやすいコードを書くことや、適切なコメントを書くことが重要です。また、コミットログやリクエストの説明もきちんと行うことがお作法です。

コードレビューでよくある問題を避けるためには？

コードレビューでよくある問題を避けるためには、事前に自分が書いたコードをレビューし、他の人のコードも見ながら学ぶことが有効です。

エンジニアとしてのスキルを向上させるためには？

エンジニアとしてのスキルを向上させるためには、継続的に学び、経験を積み、コードレビューを受け入れる姿勢を持つことが大切です。

コードレビューを受ける前に何を避けるべきですか？

コードレビューを受ける前に、機密情報を含んだ情報やマジックナンバーの使用、リレーションの見づらいActiveRecordのコードなどを避けるべきです。