今回記載するプログラミングのポイントはプログラムをキレイに見せる方法について記載します。
インデントをつける
プログラムコードを書く時にインデントをつけることをオススメします。
インデントをつけることで、プログラムを作った人以外がみてもプログラムが読みやすくなります。
インデントについては、プログラム言語・プロジェクトにより規定がありますのでプログラミングをする前に確認が必要です。
よく使われるインデントは「タブ」「半角スペース4つ」「半角スペース2つ」が使われます。
メリット
- 括弧の開始、終了位置が分かりやすくなる。
- if、for、whileなど比較、ループの中で処理されている行が分かりやすくなる。
- 可読性があがります。
デメリット
- ファイルサイズが大きくなる。
インデントがない場合の例
int point = 10;
if(point >= 70){
System.out.print("pointは70以上です。");
}else{
System.out.print("pointは70未満です。");
}
インデントをつけた例
int point = 10;
if(point >= 70){
System.out.print("pointは70以上です。");
}else{
System.out.print("pointは70未満です。");
}
気をつけること
- インデントをつけすぎるとプログラムが横に長くなり、逆に可読性がおちる可能性があります。インデントをつける場合は、あまり横のに長くならないようにすることを意識してください。
比較文は少なくする
比較文は可能な限り少なくコーディングすることをオススメします。
メリット
- コーディング量を減らすことができる。
- 検証箇所が少なくなる。
- バグを少なくするできる。
デメリット
- デメリットは特にありません。
通常通り比較文をコーディングした例
if (70 <= sum) {
passFg = 1;
} else {
passFg = 0;
}
比較文を減らすことを意識した例
passFg = 0;
if (70 <= sum) {
passFg = 1;
}
コメントをつける
プログラミングをする時にコメントをつけることをオススメします。
プログラム中にコメントがあると、コーディングした人以外が見た時にその処理は何のためにあるのか?などプログラムの内容が分かりやすくなります。
メリット
- プログラムが理解しやすくなります。
デメリット
- ステップ数が多くなります。(ファイルサイズが大きくなる)
コメントを記載した例
passFg = 0;
// 合計値が70以降の時にフラグをONにする
if (70 <= sum) {
passFg = 1;
}
気をつけること
- コメントを詳細に過剰に記載した場合、改修が発生した時にコメントまで変更する作業が発生します。そのため、コメントは一言で箇条書きすることを心がけてください。
コメント