良いコードとは？【第1回】コーディング規約を作る
良いコードとは？【第1回】コーディング規約を作る
「良いコード」の書き方は、言語によって細かい作法は変わりますが、共通する考え方があります。このシリーズでは、30年以上の開発経験の中で大切にしてきた「良いコード」の考え方を、1つずつ紹介していきます。
すべてを網羅するものではありませんが、実務で本当に役立つポイントに絞ってお伝えします。今回はその第1回、「コーディング規約を作る」についてです。
コードの書き方は、人によって（同じ人でも）バラバラになる
コードの書き方は、書く人によって大きく変わります。さらに言えば、同じ人が書いても、その日の気分や状況によって書き方が変わってしまうこともあります。
加えて最近では、ネットで調べたコードや、AIに生成してもらったコードをそのままコピー&ペーストして使うケースも増えています。こうしたコードは元の書き方の癖がそのまま残るため、そのまま組み込むとコード全体の体裁がバラバラになりやすいのです。
体裁が揃っていないコードは、確実に「読みにくく」なる
書き方が統一されていないコードは、見た目以上に大きな問題を引き起こします。パッと見て理解しづらくなるだけでなく、改修のたびに「このコードはどういうルールで書かれているんだろう」と読み解く時間が発生し、工数がじわじわ増えていきます。
これは個人開発でも起こりますが、チーム開発になると影響はさらに大きくなります。
解決策はシンプル：コーディング規約を作る
チームで開発する場合は、コーディング規約を決めて、全員がそれに沿って記述するのが基本です。規約が浸透すれば、誰が書いたコードでも、誰が読んでも迷わない状態を作ることができます。
ネットや AI から持ってきたコードについても、そのまま使うのではなく、自分たちの規約に合わせて書き直すことをおすすめします。 ひと手間かかりますが、後々の改修コストを考えれば、確実に元が取れる投資です。
ただし、例外もあります。外部ライブラリやモジュールとして独立している部分は、そのモジュール内で一貫した書き方がされていることがほとんどなので、無理に自分たちの規約に合わせる必要はありません。
技術的な相談やコードレビューについては、こちらのプランからお気軽にご相談ください。
