コードの整形
そもそも「コードの整形」って?
コードの整形とは、自分だけでなく他人が読んでも読みやすいようにコードの体裁を整えることを言います。
コードは1回書けば終わりではなく、後々見直したり、運用に合わせて変更したりします。(≒保守、改修)
自分だけが読んで理解できればいいか?と言うともちろんNOです!
1人で100%作り上げる趣味のアプリならそれでも良いですが、通常は開発現場=チームで作業します。
他の人が見ても読みやすく、簡単に直したりできる方が良いでに決まっていますね。
また、コードを成形するメリットとして、見間違えやミスを防ぐことにも繋がります。
コードの整形が行き届いていないというのは負債になります。コードを整形する癖を必ずつけましょう!
「コードの整形」のポイント
コードを整形すること自体は、何の言語を使うとしても重要です。
細かいポイントは言語によって、また、職場ごとのルールなどもありますので、郷に入っては郷に従うように。
ここでは、研修の中で気を付けていただきたい点を記載します!
・インデントを揃える
以下にインデントが揃っていない例、揃っている例を示しました。
ブロック{}で囲まれた範囲を1段下げている部分が「インデント」です。

HTMLの場合も、入れ子状になっている部分(親子関係)でインデントを下げるのが基本です。

・適切な改行
「;(セミコロン)」は1つの処理の切れ目で、日本語で言う「。(句点)」にあたります。
セミコロンがあるごとに改行しましょう。
また、else句などが続く場合でない限り、{}の後も続けて記述せずに改行した方が良いです。
//△ 改行していない例
String value; value = "TEST";
//○ 適切に改行している例
String value;
value = "TEST";
//△ 改行していない例
if (score > 100) {
System.out.println("値は100より大きいです");
} if (score == 100) { System.out.println("値は100以下です"); }//
//○ 適切に改行している例
if (score > 100) {
System.out.println("値は100より大きいです");
}
if (score == 100) {
System.out.println("値は100以下です");
}
フォーマッターを使いましょう!
上記で紹介した整形だけでも、すべて手作業でやると中々大変ですよね?
実は、整形の機能(フォーマッター)およびショートカットがあります!
サクッと整えることができるので、活用しましょう!
・「 Ctrl + Shift + F 」 : インデントと改行を整える(範囲選択しているときは範囲内のみ)
上記を定期的に使用し、コードを整えましょう。
最低限、ファイルを保存する前には必ずフォーマットするようにしましょう!
コメントの記載
コメントをたくさん記載しましょう!
コメント(// や/* */)は 実行されるコードには影響しません。
初心者のうち・研修期間の間は、とにかくコメント=メモをたくさん書きましょう!
実際の開発現場では、コメントの記載の仕方にもルールが設けられています。
その際にはなんでも書いていいわけではなく、書く意義のあるコメントを残します。
現場では、現場のルールに従ったコメントを入れることになります。
ですが研修期間のファイルについては、皆さん自身が学習するためだけの環境なのでいくら書いてもOKです!
たくさん書きましょう!!
メモをたくさん書く目的・ポイントとしては・・・
・目的 :後で見返した時に、読んで内容が分かるようにするため。
…書いた直後はいいですが、時間が経つとコードを読み直すのはある程度の時間がかかります。
・理解の過程をメモに残しましょう。
…初回で詰まった箇所は、再度詰まる可能性のあるポイントだからです。
・理解に苦労したところこそ「自分の言葉」で書く。
…自分の言葉に言い換えてアウトプットすることで理解が捗ります。
以下はコメントの書き方の例です。
・処理の流れをメモしている例(理解の助け、自分の言葉にしてアウトプット)

・何の処理か説明(問題文)を書いている例
…問題文がないと、どういった目的の処理かが分かりづらい。

