IT

元IT企業社員が語る! プログラミングをするうえで気をつけたい3つのこと!

プログラミング

私はもともとIT企業で会社員として働いていました。

その経験から、プログラミングについてはいろいろな作法を学びました。

今回は、その中でも特に大切だと思ったことを3つ紹介します!

※ここから、書いたプログラムのことを「コード」と呼びます

コード中にコメントをこまめに書く

伝える

一つ目は、「コード中にコメントをこまめに書く」ことです。

コメントとは、コードの外に日本語で書かれた注釈のことです。

第三者や未来の自分が読んでもわかりやすいように!

自分だけがコードを読んでいれば、どんなプログラムでも内容はだいたいわかります。

ですが、他の人に仕事を引き継ぐときに、コメントがないとコードが読みにくくなってしまいます

また、一年後に改めて読み返してみると、当時の自分が何を書いていたかほとんど覚えていなかったりします

そうならないために、コードの内容をコメントに残すことが必要です!

コードの内容以外にも、業務仕様などを書く!

また、コメントはコードの内容をそのまま書くだけではありません。

前提となる業務仕様が書かれていると、よりコードを解読しやすくなります

これも、仕様を知っている人間がコードを書くと「わかるから」と飛ばしがちですが、そのせいで第三者が見ると意味不明になることがあります。

できるだけ詳しく仕様を書きましょう!

条件文をできるだけ入れ子にしない

入れ子

二つ目は、「条件文をできるだけ入れ子にしない」ことです。

条件文とは?

プログラミングでは、条件によって処理をするしないを分けることが多く、その条件を書いたコードを条件文と呼びます。

言語にもよりますが、条件文にはifを使用することが多いですね。

例えばこんな感じです。

if 「サニーレタスくんが100円引きかどうか」

(100円引きの場合…しぶしぶ買う)

(100円引きでない場合…スルーする)

サニーレタスくん
サニーレタスくん
酷い例っス

条件文の入れ子とは?

簡単に言うと、条件文がこんな感じで切れずにひたすら中で続いていくことです。

if 「サニーレタスくんが100円引きかどうか」

if 「サニーレタスくんが傷んでいるかどうか」

if 「サニーレタスくんがキャベツに負けているかどうか」

(…以下延々と続く)

こうなると、中で枝分かれが倍々に増えてしまい、読みにくくなるうえにコードのテストもしにくくなってしまうのです…

条件文はこまめに分割!

なので、こんなふうに条件文をこまめに分けることが大事です!

if 「サニーレタスくんが100円引きかどうか」

(100円引きならしぶしぶ買う)

if 「サニーレタスくんが傷んでいるかどうか」

(傷んでいるならすぐ野菜室に入れる)

if 「サニーレタスくんがキャベツに負けているかどうか」

(負けているなら申し訳ないけどキャベツにする)

こうすることで、その都度何をしているかがわかりやすくなります!

サニーレタスくん
サニーレタスくん
なんか無駄に傷つけられたっス

独立した関数を作る

関数

三つ目は、「独立した関数を作る」ことです。

関数とは?

関数とは、コード内で特定の処理を行い、その結果を返すひとまとまりの単位です。

例えば、「文字列の頭3文字を切り取る」関数Aがあった場合、結果はこんな感じになります。

関数A(”12345″)

----------ここで関数Aによる処理開始----------

結果 ”123″

処理を関数化することで使いやすくなる!

よく使う特定の処理を関数として独立させておくと、非常に使いやすくなります!

例えば、先ほどの「文字列の頭3文字を切り取る」関数Aが、3桁の社員IDを切り取るために使われていたとします。

まったく別のプログラムで、「3桁の社員IDを取り出したいなー」と思ったとき、関数Aがなければ一から処理を書く必要があります

ですが、関数Aがあれば、再利用するだけで済みます!

また、関数Aのコメントに業務仕様を書いておけば、社員IDが3桁であるなどの仕様も分かりやすくなります!

※ここで挙げた例はプログラミング的には細かいツッコミがあるかもしれませんが、分かりやすくするために単純化したためです。ご了承ください

最後に

プログラミングはただ書くだけならそこまで難しくはありません。

ですが、それは往々にして他者のことを考えないコードになりがちです。

ぜひとも、思いやりのあるプログラミングを目指しましょう!


 

記事を読んで、少しでも興味を持っていただけましたら、レイニーデイのTwitterのフォローをよろしくお願いします!