チームでの開発に初めて参加して学んだこと
こんにちは、10月に入社して5ヶ月が経った新入社員のFです。エンジニアブログの3人目を任されました。よろしくお願いします。
入社してからはバリバリ自力で実装していくイメージがあり少し不安でしたが、最初は似たような実装のところがないか探して真似ると良いということを教わりなるほどと腑に落ちたので紹介します。この「似たような実装がないか探して真似る」を次の2つに分けて説明します。
似たような実装がないか探す
似たような実装を真似る
似たような実装がないか探す
似たような実装を探すことのメリットは以下の点が挙げられます。
1. 見た目から探したり、変数名で探したりとさまざまな角度からコードを見るため効率よく全体像を掴むことができる
チーム開発に参画したばかりの時はコードの全体像がまだ掴めていないので、コードの全体像を掴むことはとても大事な作業になってきます。
上から下へコードを見ていくことにプラスして、同じような見た目の部分はないか、自分が実装したいような変数や関数がすでに定義されていないかを意識すると、より効率的にコードの中身を見ていくことができます。
中でも特に私が参考にした部分は、自動テストです。自動テストはある程度書き方が決まっているということもあり、他の自動テストを参考にすることで簡単な自動テストは書けるようになりました。
似たような実装を真似る
似たような実装を真似ることのメリットは以下の点が挙げられます。
1. 実際にリリースしてあるコードを参考にできるため、自分のコードの書き方を矯正できる
当たり前のことですが、既存のコードは実際にリリースしてあるコードであるためこれを参考にすることで、自分のコードの書き方を矯正できると考えます。例えば、
1関数、1ファイルの大きさ
変数名や関数名の命名の仕方
有効的なコメントの書き方
のような細かい部分がすごく参考になります。
個人開発では規模が小さいので変数名や関数名、関数の大きさに関して深く考える必要はあまりなかったのですが、既存のコードを応用することで、大規模なチーム開発における匙加減がわかってきたように思います。
また自分の場合はAngularやRxJSがそうでしたが、初めて触るような技術に関して、公式ドキュメントを読むだけではなく要所要所の実際に動いているコードを真似ることでより実践的に勉強することができると感じました。
2. 初めて参画した人でも、サービスの見た目や中身のコードの統一感を崩さずに開発できる
似たような実装を真似ることで、見た目やコードの統一感を崩さずに開発ができます。
自分で一から開発しようとすると難しくても、似たような実装を真似ることで不具合を発生させずに実力以上の実装をすることができる可能性があります。
デザインのスタイルガイドがあまりわかっていない入社したての時は、スタイリングはなるべく既存の実装を参考にするとサービスの見た目の統一感を崩さず実装でき、デザイナーさんの確認もスムーズにできると思いました。
3. リファクタリングで共通箇所を括り出せる
似たような部分を真似て実装することで、後に共通箇所を別ファイルに移しそれぞれインポートするなりリファクタリングしてより統一性も持たせることができます。こうすることで、
コード真似る、共通箇所を応用する
共通箇所を括り出す
1と2を繰り返すことができ、二度手間を防ぎ安全に開発できるようになります。
最後に
まだまだ入社して5ヶ月の新人社員ということでわからないこともたくさんありますが、今回このような記事を書かせていただきました。他にも学んだことはたくさんあります。例えばこのようなものです。
MR, コミットは記録であることを意識する
タスクの切り替えにgit stashを活用する
VSCode で開発が捗る使い方
これらはまた別の機会に書ければと思います。この記事が少しでも参考になれば幸いです。