プログラミング学習

ソースコードを綺麗に書く必要はありますか?

投稿日:2018年9月9日 更新日:

プログラミング

スパゲティコードの画像
どうも@EaEです!

「あっ」という間に1週間が経ってしまいました。今週は本当に、本当に忙しかった....

土曜日も「あっ」という間に終わってましたね... 毎週3連休ならいいのに...

なんとかして、投稿する時間をひねり出さねば!と思っている今日この頃です。

さて、今日のテーマは

「ソースコードを綺麗に書く必要がありますか?」

です。

たぶん、新人さん指導している中で一番自分が注意していることだと思います。

「ソースコードが汚い。」と。

ただ一生懸命書いたコードを、むやみやたらに綺麗にかけと注意しているわけではありません。

ソースレビューをする上で大切なのは、相手に対するリスペクトの気持ちです! うん!

っていうか、スタートアップでスピードが命の会社にいたら、「ソースコードを綺麗にかけ!」なんて、たぶん言いません。

会社を経営している知り合いと話したことがありますが、ソースレビューなんて悠長な時間はないとのことでした...

今日の話題はあくまで、プログラマーとして、どうしてソースコードをキレイに書く必要があるかについてに言及したいと思います。

すべて書いているとキリがないので、新人さんに指導をしている中で、「これだけは分かっていて欲しい!」というものを3つにまとめました。

1.可読性の向上、読み手の負荷を軽減させる

インデントが揃えられている。命名が適格である。コメントにWhat,How,Whyが盛り込まれている。定義順にメソッドが列挙されている。

アクセッサのレベルやプロパティ、フィールドに応じて、CamelCase等が使い分けられている。

綺麗なソースコードの条件を挙げていけば、キリがありませんが、上の条件は、条件がない場合に比較して...

「明らかにソースコードが読みやすい!」

読みやすいということそれだけで一つの価値であり、個人的には重要なプログラミング技術だと思っています。

特に新人さんにはエンジニアやプログラマという言葉を聞いて、「エンジニア = コーディング = プログラミング」を思い浮かべる方がほとんどですが、

実際に「コーディング」している時間は一瞬です。ソースコードは「書いている時間」より「読まれる時間」の方が圧倒的に長く、多いので、

「読みやすいソースコード」は本当に価値があります。

 

2.バグの混入を防ぐ

これはソースの書き手自身にも、読んでメンテナンスする立場の人にも言えることですが、汚いソースコードはバグを埋め込みやすくなります。

「書いている本人は別だろ。」と思う人もいるかも知れませんが、書いている当人も例外ではありません。

変数名に気を使わないばかりに参照する対象を間違える。ネストが深すぎて、制御対象を間違える。

思いついたプロパティをその場に記述するから、探したいときにどこにあるか分からず、似たようなプロパティを複数定義してしまう。

複数定義したプロパティの使い分けができず、変数に値が格納されていない。

etc....

注意していれば、防げるような気がするかも知れませんが、ロジックを考えるのに一生懸命になっていれば、こんな事が簡単におきます。

混沌がバグを生み、バグがさらなる混沌を生みます。秩序を持ったコードを意識してください!

 

3.開発コストを下げる

綺麗に書かれたコードは結果的に開発コストを下げる効果が期待できます。

読むのに時間がかかるコード、リファクタしづらいコードは、負債・コスト以外の何ものでもありません。

仕事としてプログラムを扱う以上は、時間の制約が必ずついてまわります。

綺麗なソースコードは読むこと自体に時間がかからず、理解するにもその負荷が圧倒的に小さく済むので、時間がとられません。

 

以上、「これだけは分かっていて欲しい!」という3つをまとめてみました!

自分も他人にみせて恥ずかしくないコードを書けるように今後も精進していきたいですね。

それでは、この辺で!

  • この記事を書いた人

@EaE

ぬこ様とC#をこよなく愛する27歳です. 医療:理学療法士から、IT:システムエンジニアへ華麗?な変身をとげました. サーバーサイドエンジニアとして、日々奮闘しています. 今年の目標は、頑張ってWebサービスを作ります!!

-プログラミング学習

Copyright© Developer Wall - 開発の壁 - , 2019 All Rights Reserved Powered by AFFINGER5.