「コーディング規約」とは何でしょうか?また、どうしてコーディング規約が必要なのでしょうか。今回はそんな素朴な疑問にお答えしたいと思います。
コーディング規約とは?
コーディング規約とは、プログラムのコーディングをするに当たって、プログラミング品質を均等にするために定められた統一的なガイドラインのことです。
ざっくり言うとソースコードの書き方のルールのことを指します。
コーディング規約の内容は「命名規則」「コーディング規則」「禁止事項」など、プロジェクトの特性やその企業の文化、プログラミング言語やフレームワークの特性などで異なります。
なぜコーディング規約が必要なのか?
コーディング規約の目的は「保守性」や「可読性」の確保です。「保守性」と「可読性」とは、品質の高いプログラミングをするために必要不可欠な要素です。
もちろん、コーディング規約だけでは、品質が高いとは言い切れませんが、コーディング規約を守ることでソースコードの読解へのストレスが減り、その分ロジックの改善に充てる時間が増えるのではないかと考えます。
プロジェクトの規模にもよりますが、プログラミング作業は、複数の人が関わっています。個人で開発するケースでも、発注者にソースコードを納品した時点で、他の人が自分のソースコードを読む可能性があります。なんでも好き勝手自分の独自ルールで書いてしまうと、他の人が見た時に何をしているのかソースコードを解析するのに時間がかかってしまいます。ソースコードの解析に時間がかかるということは、その分修正する時間がかかってしまい、保守性が悪いです。
そこで、多くのプロジェクトでは開発者同士共通ルールを持ってソースコードの作成に取り掛かれるよう「コーディング規約」というルールがあるのです。
まとめ
コーディング規約は「保守性」と「品質」の確保のために必要不可欠なソースコードのルールでした。長いプロジェクトだと10年以上、自分が書いたソースコードが残っている場合もあります。
ずっと同じプロジェクトに参画しているのなら弁解の余地がありますが、プロジェクトを離れた後に、他の方から「読みにくいソース」と評価されるのは誰だって嫌ですよね。
日頃からコーディング規約の遵守の徹底と、誰が見てもわかりやすい親切なソースコードを意識しましょう。