見やすいソースコード(Java)の書き方①

プログラムは、一度書いたら終わりというものでありません。

例えば、システム開発が完了して無事に納品された後でも、不具合が発見されて

プログラムの修正が必要になることがあります。 さらに、新機能を追加する時、

後からプログラムに手を加えることもあります。

その時、プログラムがきれいにインデントされ、分かりやすいロジックで組まれていると、

プログラムの修正や機能追加の作業をスムーズに行うことができます。


もしプログラムのインデントが所々ずれていたり、ややこしくて複雑なロジックで

組まれていたりすると、 修正や機能追加の作業時にプログラムの解析に

余計な時間がかかってしまいます。このように、プログラムは単純に動けばよいというものでは

なく、 後々誰かが、あるいは自分が修正するときのことを考えて、

読みやすく、保守しやすいように書かなければ仕事になりません。


ジョブサポートのエンジニア研修で重要視している事で未経験者の人であれば1ヶ月以内には

習慣化できています。逆に我流でプログラムを勉強してきた人の方が書き方については

苦労しているように感じます。


目次[非表示]

  1. 1.ソースコードの見た目を整える
    1. 1.1.インデント(字下げ)を行う
    2. 1.2.タブ or スペース
    3. 1.3.空白(スペース)を入れる


ソースコードの見た目を整える

読みやすいプログラムを書くには、まず、ソースコードの見た目を整えて、きれいに書くことが

大切です。手書きで文章を書くときの動作に例えると、「丁寧な字で、位置をまっすぐ揃えて

書く」という感覚に近いです。ソースコードの見た目の整え方や、整える上で気をつける

ポイントについて説明します。


インデント(字下げ)を行う


ソースコードの見た目で最も重要なのがインデント(字下げ)です。

インデントとは、if や for など、波括弧 { } で作られるブロック内の各行を、1タブ分

(半角スペース4個分等)下げることです。

インデントを行うことにより、プログラムの構造が把握しやすくなります。

逆に、インデントがきちんと行われていないソースは、どこからどこまでが分岐や繰り返しの

範囲なのかが分かりづらく、 プログラムの内容を解析するのが難しくなります。

インデントが崩れているソースコードは、読みにくさのあまり、読む気を無くしてしまうこと

さえあります。 また、そのようなプログラムは、プログラムロジックの品質まであやしく

思えてきてしまいます。 ブロックの構造もきちんと整えられないプログラマに、

まともな論理構造が組み立てられるとは到底思えないからです。

プログラムを書く際は、必ずインデントを行うようにしましょう。



タブ or スペース


インデントには、タブ文字を使用する方法と半角スペースを使用する方法があります。

インデントにタブ文字を使うか半角スペースを使うかは、各プロジェクトで決められている

こともありますが、 プログラムを書く人の好みだったりすることもあります。

まともなエディタであれば、タブキーを押下したときに半角スペース4個分等に置き換えて

インデントを行う機能を備えています。 また、タブ文字を半角スペース何個分の幅で

エディタ画面上に表示するのかを指定することもできます。 よって、タブとスペースのどちらを

使用してもコーディング作業に支障があるというようなことは特にありません。

ただ、半角スペースでインデントを行っていると、 たまにソースを修正する際に誤って

スペース1文字分だけずれてしまって微妙にインデントが崩れてしまうことがあります。

通常は、タブ文字を使用したほうが、インデントがきれいに整った状態を保ちやすいです。

一般的には、インデントには半角スペース4個分の幅のタブ文字を使用することが多いようです。


空白(スペース)を入れる


変数名と演算子の間や、括弧やカンマの前/後には、適宜半角スペースを挿入し、

それぞれが識別しやすくなるようにしましょう。 全くスペースを入れずに記述してしまうと、

変数と演算子等の区切りが分かりづらくなり、読みにくくなってしまいます。

下記にスペースを挿入した記述例を示します。図が小さく見にくいですがご了承下さい。






ソースコードの書き方については何回かに分けて記載していきます。

ジョブサポートの技術研修では経験問わず人(プログラマ)にも理解できる、読みやすい

プログラムを書くために早い段階から見やすいコードを書く習慣を身に付けます。



  資料ダウンロードフォーム ジョブサポートの新人向けエンジニア研修資料(Java、JavaScript)をダウンロードフォームになります。企業名、氏名、電話番号、メールアドレスを記入して頂くと資料ダウンロードページに案内する事ができます。 Web開発・プログラミング研修(Java・フロントエンド)なら株式会社ジョブサポート


お問い合わせ

新人・未経験者向けエンジニア研修(Java,JavaScript)の
お問い合わせはお気軽にご相談ください!
〒102-0072 東京都千代田区飯田橋 3-11-13 FORECAST 飯田橋 8階