はじめに
こんにちは。未経験1年目のエンジニアです。
最近、ゼロからコードを作成する機会がありました。普段は、ほぼ完成したコードの修正や追加を行っているため、ゼロからコードを書くことに慣れておらず、かなり時間がかかってしまいました。
時間がかかった原因は、間違いなくコードが汚かったことにあります。
私は「とにかく動けばいい」という考えで、コードの整理をせずにどんどん書き進めてしまいました。その結果、同じコードが何度も繰り返され、自分が修正したい箇所にたどり着くのにも時間がかかる始末。極めつけには、「何が言いたいんだ？」という謎のコードまで完成してしまいました。
さらに、英語が苦手な私は、適当にメソッド名をつけてしまい、同じプロジェクトの方から「これ何？」と言われてしまうこともあり、ご迷惑をおかけしてしまいました。
コードを綺麗に書かないことで起きた困りごと
エラー箇所がわからない
コードが整理されていないため、どこでエラーが発生しているのか特定できませんでした。
処理がわからなくなる
複雑で冗長なコードにより、どの処理を行ったのかわからなくなってしまいました。
修正や追加に時間がかかる
目的の箇所を探すのに時間がかかり、効率が低下しました。
コードを綺麗に書くことで
綺麗なコードを書くことで、効率が上がり、修正もしやすくなります。
また、どのコードがどの部分に対応しているのかを把握できるので、開発がスムーズに進みます。
綺麗なコードは読みやすく、保守もしやすいため、開発プロセス全体がスムーズになります。同じプロジェクトチームの方たちのためにも、一緒に綺麗なコードが書けるようになりましょう！
コードを綺麗に書くために心がけること
1. コメントを書く
英語が苦手なため、メソッド名だけでは何をしているのか理解できず、わざわざそのメソッドを見に行く手間がありました。適切なコメントを書くことで、自分や他人がコードを理解しやすくなります。期日やチームでの開発を考えると、スピード感も大切です。
2. 重複したコードを書かない
同じ処理が何度も出てくる場合は、共通部分を一つのメソッドにまとめましょう。これにより、コードがシンプルになり、修正も容易になります。
3. 適切なメソッド名をつける
メソッド名は考えてもわからないことがあります。私のように英語が苦手な方は、翻訳ツールなどを活用して、「こんな感じかな？」と徐々に掴んでいくのも良いと思います。次に同じようなメソッドを作成する際に少しでも思い出せれば、それはもう成長です！
まとめ
コードを綺麗に書くことで、私自身効率が上がり、コードを書くことがより楽しくなりました。また、私は完璧主義な一面があるので、綺麗なコードを書けるだけで心が弾み、モチベーションも高まりました。
初めは時間がかかるかもしれませんが、その先にあるメリットを考えると、取り組む価値が大いにあると思います。
これからも学びを続け、より良いエンジニアを目指していきたいと思います。