3−2 Javaの約束事


1. 読みやすいプログラムの書き方

 プログラムとは不思議なもので、書いた直後は良く覚えていても、それが1週間経ち、1ヶ月も経つと、何がなんだか訳のわからない文字の羅列に変身するものです。処理の内容が複雑なのは仕方ありませんが、読みにくいプログラムというのは自分でもうんざりしてしまいます。下記のことをふまえ、プログラムの書き方を工夫して、できるだけ読みやすいプログラムを記述するように心がけましょう。

 @ 1行に1命令文を書く

 読みやすさを考えて、1行に記述する命令文は1つだけにします。

A 処理のまとまりごとにインデントをつける

 第4章で扱いますが、プログラムでは条件判断構造などを良く使います。
例えば、ある条件を満たしていれば「命令文A」を実行し、条件を満たしていなければ「命令文B」を実行するということがあります。

Javaでは、このような処理のまとまりを必ず{}で囲みますが、
下記の図1-1のプログラムでは「{} によって囲まれた部分がプログラムである」
という構造が非常にわかりにくくなっています。

 そこで、図1-2のように、{} の間の行は先頭に空白を入れて先頭を揃えプログラムをみやすくします。
これをインデント(字下げ)といいます。

図1-1
インデント無し


図1-2
インデント有り

 字下げは、プログラムの体裁上のことなのでどうでもいいことの様に思うかもしれません。
しかし、論理構造を視覚的に分かりやすく記述することは、ミスを減らす、
あるいは作業効率を上げるという観点からも重要なことです。

また、下記のように字句の途中で改行してはいけません。

図1-3


B 処理のまとまりごとに空白行を入れる

 もう一度、図1-2のプログラムを参照してください。
int
for 文の間に空白行が入っています。 処理の「まとまりごと」に空白を入れておくと、さらに読みやすくなります。

C コメントを入れる

 プログラムの中に、そのコードの内容を説明する注釈文を入れることができます。この注釈文のことをコメントと呼びます。Java はプログラムの中に半角のスラッシュを2つ続けて「
//」のように記述すると、それがコメント開始の合図になり、その行の終わりまでがコメントと見なされ、実行時には無視されます。
 このことを利用して、プログラムに自由にコメントをつけることができます。コメントには全角文字を使っても構いません。プログラムをわかりやすくするため、コメントを有効に使うようにしましょう。

D 変数名や関数名を工夫する

 作成するアプロケ-ションが複雑になればなるほど、たくさんの変数や関数を作成する必要があります。
変数や関数の名前は、コンポーネントのNameと同じようにプログラムを記述する人が自由に付けることができます。

 しかし、後で見たときに訳がわからなくなってしまうようでは大変です。
変数や関数には意味のある名前をつけるようにしてください。

2.文法エラー

プログラムは、その書き方に少しでも誤りがあるとコンパイラできないという致命的な問題になります。

@ 命令文の終わりには;(セミコロン)
 
 if文やfor文など、条件判断構造やループ構造を作成する命令文を除いて、Javaでは、
ほとんどの命令文の終わりにセミコロン(;)を付けなければなりません。
言い換えれば、セミコロンがくるまでは1つの命令文として解釈されます。

 Javaでは、引数の数が多くて1行に収まりきらない場合に、1つの命令文を複数行に分けて記述することができます。
このとき、改行のための印をつける必要はありません。
次の2つのコードは、どちらも同じように解釈されます。



A ()や{}の数

 関数の引数を囲む()や処理のまとまりを表す{}など、Javaではカッコをたくさん使います。
”(” の数と ”)” の数が一致していないと、文法エラーになります。

B 大文字・小文字の区別

 Javaでは、大文字と小文字を厳しくチェックします。
例えば下記のように”setText”を”settext”としただけで、Javaはコンパイルを通してくれません。