Javaソースコードを書くための工夫・正常処理

少しわかりやすいJavaソースコードを書くための工夫

自作Javaソースコードの書き方について、「メモ書き」です。
※2004年6月当時の記事になります。

「プログラム処理の流れ」や「変数名」「クラス名の付け方」について、少しわかりやすくするための書き方を紹介しています。「if文の条件分岐」や「メソッドの再利用」についても、書き方を紹介しています。

なお、Javaソースコードの書き方について、より詳しい(正確な)記事を読みたい方は、次の記事などを参考にしてください。
「頑健なJavaプログラムの書き方(Writing Robust Java Code)」。リンク切れ、2016年1月当時。

正常処理

Javaソースコードにおいて「正常処理の流れ」は、

  • なるべく、上から下への垂直な一本の線
  • なるべく、左側にある線
  • なるべく、「長さ」が短い線

が良い、と思います。

次のようなイメージです。青線が、「正常処理の流れ」を示しています。

正常な処理の流れ

垂直な一本の線

「正常処理の流れ」が一本の直線であることは、「処理の流れ」が一つだけ、ということを表しています。

Aの場合の処理、Bの場合の処理という風に、同時に「2つ以上の処理の流れ」を理解する複雑さはありません。
処理の場合分け」が少ないソースコードは―― if文が少ないソースコードは ――単純であり、処理内容を理解しやすいと思います。

左側にある線

「正常処理の流れ」が左側にあることは、処理の分岐が少ない(例:if文か少ない)状態を、表していると思います。この場合も、「処理の流れ」を理解しやすいと思います。

if文で処理を分岐する場合、if文の条件に対応する処理を、右側に字下げして書くことが多いです。

よって、「正常処理の流れ」が左側にあることは、「if文の字下げ」が少ないソースコード(例:if文の中に、別のif文があるという、if文の入れ子が少ないソースコード)だと、思います。

「長さ」が短い線

「正常処理の流れ」が短いことも、同じように処理を理解しやすいです。
処理する項目数が少なくて、処理全体を一覧しやすいから(眺めやすいから)です。

正常処理の例

実際のメソッドについて、正常処理の例を示します。
ここではまず、青線を見てください。

正常な処理の例

プログラムの詳細を、理解する必要はありません。

※ソースの内容がさっぱりわかりません、という感想をいただきました(2002年10月)。
ここではプログラムや利用しているクラスについて、説明がありません。
よって、どんな処理をしているのか?わからないのが自然なことだと思います。詳細を気にしないでください。

このメソッドにおいて、正常処理の流れ――青線――は、

  • 上から下に行く直線のような感じ
  • 各直線が、なるべく左側にある感じ(無駄なif文がない感じ)

になっている、と思います。

よって、「正常処理の流れ」を理解しやすいメソッドになっている、と言えます。

【まとめ記事】アプリの品質を保つため、Javaソースコードを書くための工夫

Javaソースコードを正しく書くための、ちょっとした工夫について、ご紹介しています。 変数の寿命を決める書き方。 肯定的な条件を優先して条件分岐する書き方。 クラス名…