【初心者向け】適切なインデントこそ可読性向上への近道

初心者向け

適切なインデントこそ可読性向上への近道

まずは結論、必ず適切なインデントを付けるよう心掛けましょう!

これが初心者の方でも今すぐできることですし、コードを書く上で最も重要なことの内の一つです。

実際にインデントが間違っていることでバグを埋め込んでしまったなんてことも、現場では起きています。では、続いて何故、適切なインデントを付けるべきなのかについて理由を見ていきましょう。

適切なインデントを付けた方が良い理由

理由としては、「可読性が落ちる」これに尽きます。

可読性が落ちるということは本当に厄介なもので、バグを受けこみやすくなったり、バグを埋め込まないまでも、コード理解に時間がかかったりする原因になります。

ではでは、本当に可読性が落ちるのかについて、具体例を見ていきましょう。

適切なインデントのありなしでどの程度可読性が変わるのか検証

下記の、適切なインデントあり(Sample01クラス)とインデント崩れ(Sample02クラス)を見比べてください。

public class Sample01 {

	public static void main(String[] args) {
		// インデントあり
		if (args == null) {

		} else {
			if (args != null && args.length > 0) {

			}
			if (args != null && args.length > 1) {

			}
			if (args != null && args.length > 2) {

			}
		}
	}
}
public class Sample02 {

	public static void main(String[] args) {
		// インデント崩れ
		if (args == null) {

			} else {
		if (args != null && args.length > 0) {

			}
			if (args != null && args.length > 1) {

			}
			if (args != null && args.length > 2) {

		}

			}
	}
}

どちらとも同じ内容のコードですが、適切なインデントありの方が読みやすいですね。
これにIF文の中身も書き入れた場合を考えたらゾッとしませんか?

IDE開発統合環境を利用されていることが殆どだと思うので、それぞれの環境で自動フォーマットを掛けてくれる機能を有しているはずなので、そのような機能も活用しましょう。

ちなみに私が良く利用しているEclipseであれば、フォーマットしたい箇所を選択した状態で「Ctrl+Shift+r」で自動的にフォーマットしてくれます。

さいごにまとめ

どうでしたか?インデントありのコードの方が断然読みやすかったと思います。

可読性を向上させる第一歩ですから、必ず適切なインデントを付けるよう心掛けましょう

そして、最後まで読んでいただきありがとうございました!

下記記事ではキレイなコードを書くコツをまとめてます。

【初心者向け】スパゲッティコードから脱出する方法3選+α
基本的な文法を理解してある程度プログラムを書けるようになってくると、本人しか理解できないようなコード(※以降、スパゲッティコード)を量産する危険性が増してきます。スパゲッティコードは自分だけでなく、他のメンバーを困らせる原因にもなるので、早い段階でスパゲッティコードから脱出する必要があります。本記事では、スパゲッティコードを脱出し、華麗なコード(※以降、カレーコード)を書くための「知識・技・考え方」について解説していきます。

では最後まで読んでいただきありがとうございました!

より詳細な情報を知りたい方はリーダブルコードという本がオススメです!ソースコードは一度書いて終わりではありません。どうしたら読みやすく保守しやすいコードを書けるのかについて知ることが出来る一冊です!

コメント

タイトルとURLをコピーしました