catch-img

新人SE・PG教育にも使える!見やすいソースコード(Java)の書き方①

今回はJavaのソースコードの書き方について説明していきます。

ジョブサポートのJava研修でも講師が非常に重要視している事で、プログラミング未経験者の

人でも研修などで日々教育を受けていると自然と習慣化されてきます。

逆に自学で指導者がいない状況でJavaやその他のプログラムを勉強してきた人の方が

新人研修時に書き方については苦労しているように感じます。

今回弊社の研修情報を活用して複数回に分けて説明していきます。

新人SE・PGの研修に関わる方にも活用できる情報だと思います。

目次[非表示]

  1. 1.プログラムは、一度書いたら終わりではない
  2. 2.ソースコードの見た目を整える
    1. 2.1.インデント(字下げ)を行う
    2. 2.2.タブ or スペース
    3. 2.3.空白(スペース)を入れる


プログラムは、一度書いたら終わりではない

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

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

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

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

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


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

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

しまいます。このように、プログラムは単純に動けばよいというものではなく、 後々誰かが、

あるいは自分が修正するときのことを考えて、読みやすく、保守しやすいように書かなければ

仕事になりません。

プロエンジニア育成コース(Java・フロントエンド)ー株式会社ジョブサポート

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


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

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

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

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


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


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

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

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

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

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

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

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

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

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

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

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

短期講座(Java入門5日・基礎10)ー株式会社ジョブサポート

タブ or スペース


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

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

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

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

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

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

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

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

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

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

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


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


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

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

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

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




今回は、Javaのソースコードを見やすくするためにインデント(字下げ)、タブ or スペース、

空白(スペース)について説明をしました。

次回以降もJavaのソースコードの書き方含め何回かに分けて記載していきます。

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

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

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

通年でJava研修(オンライン・リモートも対応可)の受け入れを行っており、助成金を活用すれば

費用を軽減して研修受講が可能です。詳しい詳細などがお問い合わせ下さい。


資料請求はこちらから

職場で使用されているアドレスをご記入下さい。

アップロードしています。少々お待ちください。