【Java初心者】ソースコード記述時の注意点

Javaでプログラミングをする際に、意識するべき点について解説していきます。
せっかくワクワクするソースコードを書いても小さなミスに気が付かないために
なかなか実行ができないのでは勿体無いのでぜひ楽しいプログラミングを！

1. ソースコードは一語一句正確に！
- 1.1. 大文字小文字を区別する
- 1.2. 似ている文字や記号を意識する
2. 読みやすくてスッキリしたコードを！
3. 上からではなく外から！
4. まとめ

ソースコードは一語一句正確に！

ソースコードを記述していると多くの変数、メソッド、クラスなどを扱うことになります。

ぱっと見は正しいようでも１文字でも間違った文字を入力してしまうと
プログラムは正常に動作しません。

プログラムが大きくなってくると些細な誤字脱字でも、
見つけるのに苦労して挫折してしまうなんてこともあるかもしれません。

常に正しい記述をするように心がけましょう！

大文字小文字を区別する

大文字小文字の間違いは頻発する問題の１つです。

プログラムが大きくなってきた場合、似たような名前の変数やメソッドを
利用する場面が出てきます。

大文字と小文字を間違えてコードを書いてしまい、エラーが出ずに
プログラムが動いてしまうと間違った挙動になっていることに
気が付きにくくなってしまいます。

例えば以下のようなコードは一見すると正しいように見えますが
製作者が想定した通りには動作しません。

		int sample = 0;
		int Sample = 0;
		sample = 1;
		sample = 2;　　　　　⇦Sampleに代入したいが[S]を小文字にしてしまっている
		System.out.println("sdample="+sample);
		System.out.println("Sample="+Sample);

想定結果

sample=1
Sample=2

実行結果　(間違った結果が出てしまっている。)

sample=2
Sample=0

似たような名前を利用している場合には、大文字小文字の間違えがないか頻繁に確認してください！

また、ソースコードは全角ではなく、半角で記述することにも注意しましょう！

似ている文字や記号を意識する

似ている数字や英字、記号を打ち間違えていないかよく確認しましょう！

ソースコードを少し書いたら、デバッグや実行を行い、変数やメソッドの中身が
想定している通りになっているかを確認してください。

頻繁に確認を行うことで、全体が完成してから思っていた挙動と違うといったような
問題が発生する可能性が減ります。

以下の例を参考に、ソースコード記述しながら、間違いがないか確認を行ってみてください！！

読みやすくてスッキリしたコードを！

メソッドで機能ごとに分割

１つの機能ごとにメソッドで分割することにより、

あとから「あの機能を変えたい！」と思ったときにすぐに変えられる。
同じ処理を何度も行うときに専用メソッド一つで対応しやすい

などの様々なメリットがあります。

ソースコードが1000行、10000行と大きくなってきたときに重要なスキルとなります。

メソッドを分けない場合 (同じ長い計算式を何度も書かなくてはいけない)

	public static void main(String[] args) {

		int a = 1;
		int b = 2;
		int c = 0;
		int d = 0;

		c = a + b + a + b + a + b;   ⇦　　　　　足し算が複数あるので何度も記述している
		d = a + b + a + b + a + b;

		System.out.println("c = "+c);
		System.out.println("d = "+d);
	}

メソッドを分割した場合 (計算式は１度書いてあとはメソッドを呼び出すだけ)

	public static void main(String[] args) {

		int a = 1;
		int b = 2;
		int c = 0;
		int d = 0;
		c = addition(a,b);   ⇦メソッドを呼び出しているだけ！！
		d = addition(a,b);
		System.out.println("c = "+c);
		System.out.println("d = "+d);
	}

	public static int addition(int a , int b) {　　　⇦計算用のメソッド

		return a + b + a + b + a + b;
	}

メソッドの詳細につきましては、以下の記事についても説明しておりますので
ぜひご確認ください。
【Java初心者】メソッドの使い方と利点

インデントで区切りをつけて見やすく！

インデントとは、行の先頭に空白などを入れて文章を見やすくすることです。
クラス　⇨　メソッド　⇨　命令文　の順で具体的になっていくほど
インデントを下げていくのが基本です。

また、インデントを入れることによってどこまでが1つのメソッド、クラスなのかを
見分けることが容易になります！

以下の例でも見やすくなっているのを感じると思います。

インデントなし

public class Sample {
public static void main(String[] args) {
System.out.println("こんにちは、ケニー");
System.out.println("やぁ、マイク");
System.out.println("キャサリンはどこにいるんだい？");
System.out.println("あそこでハンバーガーとホットドックを食べているわ");
}
}

インデントあり

public class Sample{
	public static void main(String[] args) {
		System.out.println("こんにちは、ケニー");
		System.out.println("やぁ、マイク");
		System.out.println("キャサリンはどこにいるんだい？");
		System.out.println("あそこでハンバーガーとホットドックを食べているわ");
	}
}

コメントをつけてわかりやすく！

コメントとは、ソースコードが実際にどんなことを行っているものかを説明するために使用します。
実際にプログラムを実行した際にはコメントは一切影響を及ぼしません。

コメントを書く際は、コメントを書きたい行の先頭に「//」をつけます。

複数行にわたってコメントをつけたい場合は、
「/*」「*/」でコメントにする行を囲むだけでコメントになります。

サンプルコード

public class Sample{

	/*
	 このメソッドには英語の教科に載っていそうな
	 英会話を記載した！
	 */
	public static void main(String[] args) {
		System.out.println("こんにちは、ケニー");
		System.out.println("やぁ、マイク");
		//System.out.println("キャサリンはどこにいるんだい？");
		//System.out.println("あそこでハンバーガーとホットドックを食べているわ");
	}
}

実行結果

こんにちは、ケニー
やぁ、マイク

上からではなく外から！

ソースコードは上から下へ順に書いていくのではなく、
外から中へ書いていくことを意識しましょう！

何事も大きな枠組みから決めて、その後に詳しい内容を決定していくように
ソースコードも「クラス　⇨　メソッド　⇨　命令文」の順で固めていきます。

サンプルコード

public class Sample3 {　　　⇦　　　　１番最初！！

	public static void main(String[] args) {　　　　　　　　　　　　　⇦２番目
		System.out.println("こんにちは、ケニー");　　　　⇦最後！
		System.out.println("やぁ、マイク");

	}
}