きれいなソースコード

ソースコードをきれいに書く3つのポイント

きれいなソースコード

「このソースコード誰が書いたんだ?読みづらい」と思ったことありませんか?

 

私はすごくあります。そんなソースコード見るとテンションが下がります。

 

自分で書いたソースがそんな風に思われたくないですよね。

そこで、私が「きれいなソースだな」と思う3つのポイント説明します。

 

ソースコードをきれいに書く3つのポイント

checklist

 

私が「きれいなソースコードだな」と思う3つのポイントは次の通りです。

  1. インデントをそろえる
  2. コメントを書く
  3. なるべく簡単なコード

私もソースコードを書くときにこの3つを意識して書いています。

 

きれいなソースを書くコツ(方法):1.インデントをそろえる

インデント

 

ソースコードを書いたことがある人は馴染みのある言葉だと思いますが、「インデントをそれえる?」となっと人のために、まず復習をかねて”インデント”についてザックリ説明します。

 

インデントとは

インデント

 

上の図を見てもらうとわかるように、字下げのことです。

 

なぜ、これできれいに見えるのか

そろっているいることで、「どの処理の中に、どんな処理があるか」が直感的に把握できるからです。

 

例えば、私が普段使っているソフトの”Visual Studio”では標準の設定でインデントをそろえるような設定がされています。

 

あくまでソフトなので、自動でうまくインデントがそろわないことがあります。そろわないことは「別にしかたないかな」と思っていもいますが、たまにそろっていないままになっていることがあります。

 

記述量が少ないものなら、「はぁ~」と思うだけですが、深い階層の記述量の多いものになってくると「あ~~~!!!わけわかんね~」となってしまいます。

 

 

他人のソースコードを見る機会が多い人はわかると思いますが、作業のまず始めは「現状の把握」です。

ソースコードのインデントがバラバラで書いてあったら理解しづらい

 

ぶっちゃけこれはプログラミングの基本的なことなので、これができていない人は素人レベルです。

 

きれいなソースを書くコツ(方法):2.コメントを書く

コメント

 

これができていない人が多い!

自分はプログラムを書いている本人だから、わざわざ説明がなくても理解していると思いますが、他人が見たらどうですか?

パッと見て理解できるソースコードですか?

もし、コメントが書かれていない場所で不具合が発生して、1年後に自分で見てその処理の内容を瞬時に理解できますか?

できないと思います。

私は1年前に書いたソースコードを覚えていません。というよりも、たくさん書きすぎて覚えていられません。

 

他人が見るとなると余計に理解に時間がかかる

そうならないためにも、めんどくさいとけど1つ1つの処理に説明書きを残すことで後で見たときに楽になります。

 

きれいなソースを書くコツ(方法):3.なるべく簡単なコード

programmer

 

ベテランや中堅のプログラマーによくあるのですが、やたら小難しい技術を使いたがるということです。

別にそれがメジャーなコードだったら別に問題ないですが、「わざわざこんなことしてるし・・・」と思うことがたまにあります。

 

 

技術力だけに注目すると、「こんなやり方があるのか」を関心しますが処理は簡単なコードに越したことはありません

前項でも言いましたが、「他人が見てどう思うか」を考えてコードを書かないとただの自己満です。

 

まとめ:新人でも理解できる

新人でもわかる

 

プログラミングきれいなソースコードの書くポイントを説明しました。

 

「他人が見てどう思うか?」、逆に言えば、「自分が他人のソースコードを見てどう思うか」ということです。

 

自己満なソースコードにならないために、どのようなことを意識してソースコードを書けばよいかというと、私は「新人でも理解できつように」ということを意識しています

 

新人のプログラマーは知識も技術もまだまだ乏(とぼ)しいことが多いです。

そんな人にでもすぐ理解できるような書き方を意識することで、中堅やベテラン陣がそのソースコードを見ると、瞬時にどんな処理か理解できます。

 

わかりやすいソースコードを書くことでどんなメリットがあるかというと、大きくは次の3つです。

  • ソースコードをスラスラ読める(理解できる)
  • 修正が起こったときに楽 ←現状理解が簡単だから
  • わかりやすく理解しやすいので、工数の削減が期待できる

 

ぶっちゃけ管理者目線で言うと、読みやすいソースコードを書いていると評価したくなる。理由は上で書いた通りです。

 

自分が見たときもわかりやすくなるし、他人から見た時もわかりやすいし、評価もされるならきれいなソースコードを書かないメリットがありませんよね。

 

ベテランも中堅も新人も、きれいなソースコードを書く工夫をすることで自分の仕事が楽になりますよ。嘘だと思うなら1回試してみてください。絶対変わりますよ。

 

あわせて読まれている記事

 プログラムにもトレンドがあるって知っていましたか?8年間システムエンジニアをやっていて、いろんな企業の案件に参画してきましたが今と昔ではプログラムの書き方や画面のデザインも変わってきています。 […]

laptop