Javaのコードを綺麗にかくコツ　ー客観的視点を持つー

はじめ

今回から、Java関連の記事を投稿します。そのはえある第1つ目の投稿は、「コードを綺麗に書くコツ」についてお話しします。

今回のリポジトリはこちらから

https://github.com/rii125/Sample_Code/tree/main

【視覚的に】読みやすいコードを書くには？

Javaのコードを読みやすいものにするには、

• インデント
• コメントアウト

この2つのバランが良いと視覚的に読みやすいコードができます。

コードを書く時のインデント

インデントを入れる癖をつけましょう。

https://github.com/rii125/Sample_Code/blob/main/indent/Sample_01.java

https://github.com/rii125/Sample_Code/blob/main/indent/Sample_02.java

また、変なインデントは行わないようにしましょう。

https://github.com/rii125/Sample_Code/blob/main/indent/Sample_03.java

コメントする時

コメントは、個人開発・集団開発の時わかりやすい説明をするよう心がけましょう。

個人開発なら？

複数行のコメントアウトを行うと効率的に作業ができます。

https://github.com/rii125/Sample_Code/blob/main/commentout/Sample_01.java

集団開発なら？

できるだけ一行のコメントアウトを行うと集団での開発

https://github.com/rii125/Sample_Code/blob/main/commentout/Sample_02.java

【誰でも理解できる】読みやすいコードを書くには？

誰でも理解できるコードを書くためには、

• 変数名の定義・配列名の定義
• 変数と定数の区別
• メソッド名の定義

この3つのバランスが良いと誰でも理解できる読みやすいコードが書けます。

変数名の定義

変数名は、見る人が構造を理解しやすいような名前が理想的です。

https://github.com/rii125/Sample_Code/blob/main/seeCode/Parameter/Sample_01.java

このコードは、「何かをカウントするものだ」と推測できるのでcountが使われているプログラムは何かをカウントしているという推測が簡単にできるので、変数名は数値や値の情報の窓口になっています。

https://github.com/rii125/Sample_Code/blob/main/seeCode/Parameter/Sample_02.java

逆に、変数aaはなんの数値なのか見当もつかないためプログラムに使用された時の推測が困難になる可能性があります。

配列名の定義

変数名と同様、見る人が構造を理解しやすいような名前が理想的です。

https://github.com/rii125/Sample_Code/blob/main/seeCode/Array/Sample_01.java

配列名Numは数値を複数格納できる変数だと推測できます。

https://github.com/rii125/Sample_Code/blob/main/seeCode/Array/Sample_02.java

aaは、どのようなものなのか見当もつかない名前なので混乱が生じます。

メソッド名の定義

メソッドを定義する際には一行目が大まかな処理の内容を記述しておくとわかりやすいコードになります。

https://github.com/rii125/Sample_Code/blob/main/seeCode/methodName/Sample_01.java

https://github.com/rii125/Sample_Code/blob/main/seeCode/methodName/Sample_02.java

終わりに

いかがでしょうか？今回の記事は、自分がJavaを学習した際の反省点を踏まえて書きました。
Java以外の学習にも役立つと思うので、ぜひ保存の方をお願いします。