Javaの基本的なコードの書き方やルール

2023-10-11

りある

まとめるよ～。

ブログ内のJavaプログラミングコードについて

Javaのコードは基本的にクラスやメソッドを省いた形で載せています。
コードをコピペで試したいときは、クラスとメソッドを書き足してください。

基本的なコードの書き方やルール

インデント

Javaでは通常コードの可読性を高めるために、インデント（文字の先頭に空白を入れて右にずらす）を使用します。
インデントには、スペース 4 つまたはタブ 1 つを使用します。
インデント（文字の先頭に空白を入れて右にずらす）は半角入力で、全角は×。
インデントしなくてもプログラムは動作しますが、コードブロックが読みやすくなりヒューマンエラーを防止できます。

public class MyClass {
    public void myMethod() {
        if (condition) {
            // インデントしていく
        }
    }
}

複数行

長い行は複数行に分けて読みやすくすることが推奨されます。
改行するときは、行頭にスペース 4 つまたはタブ 1 つを空けて、コードの可読性を高めます。

// 改行しないコード
public class Main {
    public static void main(String[] args) {

        int number = 10;int number2 = 20;int number3 = 30;
        System.out.println( number + number2 + number3);
        
    }
}

// 改行したコード
public class Main {
    public static void main(String[] args) {
               
        int number = 10;
        int number2 = 20;
　　　　 int number3 = 30;

        System.out.println(
        number +
        number2 +
        number3
        );
        

    }
}

改行したコードの方が、可読性が高くなっています。

コードの目的や処理内容を説明するために、コメントを使用します。
コメントは、// または /**/ を使用して記述します。

// コメントなしのコード
int number = 10;
int anotherNumber = 20;

System.out.println(number + anotherNumber);

// コメント付きのコード
// 10 と 20 を足す
int number = 10;
int anotherNumber = 20;

// 合計を表示する
System.out.println(number + anotherNumber);

コメントを使用したコードの方が、理解しやすくなります。

/**
 * このメソッドは～を行うためのサンプルメソッドです。
 * param param1 パラメータ1の説明
 * param param2 パラメータ2の説明
 * return 処理結果の説明
 */
public int sampleMethod(int param1, int param2) {
    // メソッドの実装
}

禁止事項

同じ名前の変数とフィールドを宣言することは禁止されています。

// 同じ名前の変数とフィールドを宣言するとエラー
int number = 10;
int number = 20;

このコードはコンパイルエラーになります。
以下も禁止されています。

同じ名前のローカル変数とフィールドを宣言する
同じ名前のメソッドを宣言する
同じ名前のクラスを宣言する
同じ名前のパッケージを宣言する
同じ名前のインターフェースを宣言する

りある

ようするに、名前がかぶったらダメってことだね。

命名規則

Javaのコードでは、以下の命名規則に従って、変数、メソッド、クラス、パッケージ、インターフェースの名前を定義します。

変数名は、小文字で表記し、複数の単語で構成する場合は、単語の間に大文字を使用する「キャメルケース」を使うのが一般的です。

myName myAge など

定数名は、すべて大文字で表記し、複数の単語で構成する場合は、単語の間にアンダースコア（_）を使用する「スネークケース」を使うのが一般的です。

ADD_NUMBERS MY_MODULE など

関西AIラボ

Javaプログラミングの変数と定数 | 関西AIラボ Javaプログラミングの「変数」と「定数」のルール変数と定数は、プログラムでデータを保存するために使用されマス。変数は値を変更でき、定数は値を変更できないという点…

アッパーキャメルケースとロアーキャメルケース

Javaの、アッパーキャメルケース（UpperCamelCase）、ロアーキャメルケース（lowerCamelCase）は、変数やメソッド、クラスなどの名前を記述する方法です。

一般的には、以下のルールに従って使用されます。

クラス名やインターフェース名はUpperCamelCaseを使用する。
変数名やメソッド名はlowerCamelCaseを使用する。

UpperCamelCase

UpperCamelCaseは、単語の先頭を大文字にして、それ以降はすべて大文字で記述する方法です。
クラス名やインターフェース名などに使用されます。

public class MyClass {
    public void myMethod() {
        // ...
    }
}

lowerCamelCase

lowerCamelCaseは、単語の先頭を小文字にして、それ以降はすべて小文字で記述する方法です。
変数やメソッド名などに使用されます。

int myNumber;
void myMethod() {
    // ...
}

このルールに従うことで、コードの可読性が向上します。

例：

// 変数の名前を小文字で始める
int number = 10;

// メソッドの名前を小文字で始める
void printNumber() {
  System.out.println(number);
}

// クラスの名前を大文字で始める
class MyClass {
  void printNumber() {
    System.out.println(number);
  }
}

// インターフェースの名前を大文字で始める
interface MyInterface {
  void printNumber();
}

// パッケージの名前は小文字で統一し、複数のパッケージはドット(.) で区切って記述
package com.example;

まとめ

Javaの基本的なコードの書き方やルールを、表でまとめると以下のようになります。

項目	説明
インデント	スペース 4 つまたはタブ 1 つを使用して、コードを整形する
複数行のコード	改行して記述する
コメント	`//` または `/**/` を使用して、コードの目的や処理内容を説明する
禁止事項	同じ名前の変数やメソッドを宣言しない
命名規則	変数やメソッドの名前は小文字で始める、など