【プログラミング】ソースコードのフォーマットを整える重要性

こんにちは!CODE CLUB965のKです!

今回は、ソースコードのフォーマットについて書こうと思います。
プログラミングをするうえで、ソースコードのフォーマットを整えることは非常に重要です。
これまであまり意識をしてこなかった方は、これを期に意識してもらえたらと思います!

フォーマットを整えることの重要性

ソースコードを書くことに夢中になっていると、フォーマットを整えることをついついサボってしまうかもしれませんが、フォーマットを整えることは非常に重要です。

フォーマットを整えることで、

ソースコードの可読性が上がり、
バグ混入の可能性を減らす

ことが出来ます。

フォーマットが正しく無いために起こるバグのよくある例が、
インデントずれによりif文やfor文の範囲を間違えることです。

if (sample == "sample text"){
    // ifがtrueの時のみ実施する処理1
    
    // ifがtrueの時のみ実施する処理2
}

// 必ず実施する処理

こちらは正しい例です。
これであればif文の範囲はわかりやすいです。

しかし、以下のように実装してしまうと、if文の範囲がわかりにくくなってしまいます。

if (sample == "sample text"){
    // ifがtrueの時のみ実施する処理1
    }
// ifがtrueの時のみ実施する処理2

// 必ず実施する処理

この例では、ifがtrueの時のみ実施する処理2の実装箇所が正しく無いことがパッと見でわかりにくいかと思います。

以下のようにインデントが正しく合っていれば、バグにもすぐに気付けます。

if (sample == "sample text"){
    // ifがtrueの時のみ実施する処理1
}
// ifがtrueの時のみ実施する処理2

// 必ず実施する処理

いかがでしょうか?
インデントを正しく揃えることの重要性がわかるかと思います。

フォーマットで特に重要なのは、以下です。

1. インデント
if文やfor文などのスコープ間違いにすぐに気付ける。

2. 1行の長さ
1行が長いとスクロールしないと全体が見えなかったりするので、
1行の長さを制限することでコードの可読性が上がる。

コードの自動フォーマットを設定すると良い

いちいち手動でフォーマットを整えるのも手間なので、統合開発環境の自動フォーマット機能を利用すると良いです。

どの統合開発環境を使っていても、必ず提供されている機能です。

設定によりますが、例えば、コードの保存をしたタイミングで自動でコードのフォーマットを整えることが出来ます。

開発しているプログラミング言語のフォーマッター(フォーマットのルール)を入れたうえで、自動フォーマットの設定を行います。

例えば、VisualStudioCodeを使っている方は、以下の記事を参考に設定してみて下さい。
Visual Studio Codeで保存時自動整形の設定方法

ぜひ、自動フォーマットを設定したうえで、ソースコードのフォーマットを整えるようにしてみて下さい。
コードの可読性が上がり、プログラミングがしやすくなるはずです。

それでは、また!