読みやすいコーディング

この記事を書いたチーム:frontier

 

はじめに

【エンジニア募集中】フルリモート可◎、売上/従業員数9年連続UP、平均残業8時間、有給取得率90%、年休124日以上 etc.  詳細はこちらから>

読みやすいコーディングにおいて一番大事なことは、

「他人が理解しやすいように書く」ことだと思います。

コードは書いた瞬間だけでなく、後から読む人(未来の自分を含む)が理解できて初めて価値があります。どんなに高度なアルゴリズムでも、読みにくければバグの潜在要因になり、保守や改修に時間がかかります。

この「他人が理解しやすいように書く」という意識が、命名、コメント、構造、関数設計などすべての判断の軸になります。

 

変数名

変数名を、xiなど何に使用しているか分かりづらいものにせず、pricetellNoなど、変数名を見れば何に使用しているのか分かるものを使いましょう。

 

コメント

この処理は何をしているのか?なぜこの処理が必要か?を意識して、適切にコメントを残すようにしましょう。

 

フォーマット

インデントを正しく使い、ネストが深くなりすぎないように注意しましょう。

処理のまとまりごとに空行を入れることで、視覚的に読みやすくなります。

また、1行の長さは80120文字程度に抑えると、横スクロールの必要がなくなり、可読性が向上します。

 

リファクタリング

1度書いたコードは少し時間をおいて自分で見直すことで、改善点が見えてきます。他人のレビューを受けることで、自分では気づけなかった問題点を発見できることもあります。また、他人の書いたコードを読むことで、自分のコードとの違いを考えることも重要です。

 

さいごに

上記にいくつかポイントを記述しましたが、技術的なテクニックよりも、読む人への思いやりが重要になります。コーディングをする際、読む人への思いやりを意識してみるとより良いコーディングができると思います。

【エンジニア募集中】フルリモートも◎(リモート率85.7%)、平均残業8時間、年休124日以上、有給取得率90% etc. 詳細はこちらから>

Smallitのサービス