【VB.Net】書いてきた経験からコードを書く際に気を付けていることベスト5

どうも!リョクちゃです。

今回は、筆者がコードを書く際に気を付けていること5項目を紹介していきます。

ちなみに前回はこちら、

ファイルダイアログを使って、パソコンに保存されている適当なファイルを操作する方法を紹介しています。ファイルダイアログとは、ファイルを保存する際に保存先等が設定できる小ウィンドウが開きます。このウィンドウをファイルダイアログと呼んでいます。



例えば、下のようなコードがそれぞれ同じクラス内にあったとします。

それぞれボタンを押すことで、入力値の大小を判定する処理が書かれています。

判定方法は各ボタン全く同じです。

こういった場合は、新たにメソッドを作成し、1つにまとめるほうが

コードも見やすくなるうえに作業効率も上がるので

同じような処理を書いている箇所については1つにまとめることができないか

工夫するように筆者はしています。

上のコードをまとめると、下のようになります。

エディタ上だと、

判定する処理を1つの関数にまとめています。

② 何の処理をしているかわかりやすいようにコメントを残す

最近ではコメントを残し過ぎるのもよくない傾向にありますが、

といってもコメントは重要です。

本来は誰が見てもわかりやすくがベストなのですが、

書き手によってコード思想や概念が違うので難しさもあります。

そこで必要最低限わかりやすいコメントを残す方がよいと筆者はわかっています。

ただ、コメントもだらだら残すのではなく、簡潔に残すのがいいでしょう。

コメントの残し方に関するイメージを下図に示します。

③ 変数名やメソッド名は誰が見てもわかりやすいように付ける

他の人のコードを見てもわかりやすいようにするのが筆者はよいと考えています。

そのため、変数名やメソッド名もわかりやすくしましょう。

これ以外と、わかりづらい名前や自分にしかわからない略称で名前をつけてる方もおります。

実際に筆者に周りにもいて、話を聞いてみると、

「みんな知っているかと思っていました、それで略称にして短くしました」

たしかに、短くするにはいいのですが変数名などで短くするのは

処理の後に考えるのがいいのかなと思ってます。

自分が知っている≠みんなが知っている

基本的に自分が知っていることは他人も知っていて当たり前ではなく

誰も知らないからわかりやすくするを軸に考えてもらえればなと思います。

例を下に、

IDU = Indoor Unit (室内機)

GetIDU_Info → GetInDoorUnit_Info

MSG_HW → MSG_HelloWorld

などのように、略称でも一意に定まるような略称ならいいですが

どうともとれるような解釈が複数に分かれる場合は、

なるべく略さずに付けてあげるのを推奨します。



④ クラスやメソッドで同名の変数は使用しない

例えば、こんな場合

いずれの変数も最初はどの値を持っているかわかりますが、

様々な処理を行っていく上で変数の中身が変わっていく場合、

同名の変数を使っているとどの変数に何の値が入っているかわからなくなってしまいます

これを避けるうえで、なるべくクラスやメソッドで同名の変数を使わないようにしましょう

全体に持たせたいときは、

クラスでメソッドで完結できる場合はメソッドのみでわけて使うように心掛けましょう。

⑤ 1つのメソッドにIf文は、5~6階層まで

これも書く人によってもっと浅い層がよかったりとありますが、

筆者はだいたい5~6階層としています。

ちなみにこの階層とは……

If文による書き方を階段に見えることから階層と呼んでいる。

別として、ネストと呼ばれる、たぶんこちらの方が一般的です。

階層が深くなると、

  • 視覚的に処理の構造が把握しづらい。
  • 書き手の脳の負荷が大きい。
  • 書き直したくても被害が大きくなる可能性大。

といった問題が挙げられます。

上述で載せたコード例を見てもわかるように階層が深くなるにつれ、

どんどんコードは複雑化し見づらくなってきます。

実際5~6階層でも深いのですが、書き始めはこの程度の深さまでなら許容できると思います。

だんだんと慣れてきたら様々な書き方を駆使し、階層を浅くするようにしていき、

ある程度の域に達した段階で4~5階層までにとどめるようにしていきましょう。

階層が深くなりそうなら、条件を見直してまとめることができる条件であるなら、

論理演算しを駆使して1つの条件式にまとめるなど考えるようにしましょう。

条件をまとめようとして、逆に条件が複雑化してしまったという場合もあるので、

ケースバイケース、状況に応じて分けて考えられるようにしていきましょう。

まとめ

筆者がこれまでのプログラミング経験で気を付けておきたいことの解説をしていきました。

この他にもまだまだ気を付けねばいけないこといっぱいありますが、

中でも特に気を付けているものベスト5でした。

一緒にVB.Netを極めていきましょう。

最後までご覧いただきありがとうございます。

・こちらの書籍を参考にVB.Net勉強しています。

スポンサーリンク