美しく見やすいソースコードを書くために意識したい4つのポイント

プログラマーにとって美しく見やすいソースコードを書けることは重要なスキルの一つです。なぜならアマチュアプログラマーではなく、仕事として取り組むのであれば、自分以外の人がソースコードを見る可能性が大いにあるからです。

プログラムのバグ対応を引き継いだとき、もしソースコードがぐちゃぐちゃだったら、もとのソースを書いたプログラマーに対して怒りさえ覚えてしまいます。そんなことにならないためにも、美しく見やすいソースコードを書くためのポイントをご紹介していきたいと思います。

きれいなソースコードを書くにはここを意識する

それではさっそく、プログラマーなら覚えておきたい、ソースコードを美しく見せるためのコツについて、ご説明していきましょう。

インデントをしっかりとつける

基本中の基本ではありますが、インデントはしっかりとつけるようにしましょう。「インデントなんて当たり前だろ」と思われるかもしれませんが、たまに新人エンジニアがインデントをつけることなく、左端が縦一直線にびっちりと揃ったソースコードを書いてくるので驚きです。

ソースコードにとってインデントはとっても大事。処理の分岐などを”ぱっと見”で判断する材料にもなりますので、インデントがないソースは読みづらくてしかたありません。

ちなみにインデントとは文字が始まる前の余白のことであり、字下げという言い方もします。以下に例を挙げますが、左側の空白の部分がまさしくインデントですね。

このようにしっかりとインデントをつけておくと、以下のようにインデント無しのソースコードよりも美しく、見やすくないでしょうか。

適宜コメントを挿入

プログラミング言語も慣れてくれば読むのも早くなりますが、それでも全体の動きを捉えるためにはコメントを追った方が早いです。複雑な処理であればあるほど、コメントの重要度も高くなります。

自分でプログラムを組んでいるときには、そのロジックがすべて頭の中に入っているのでコメントは必要ないかもしれませんし、いちいちコメントを入れるのは面倒な作業かもしれません。しかし後になって過去のプログラムに改修が入り、ソースコードに手を入れる際にコメントがないと、いちいちソースコードを解析していかなければなりません。

人のプログラムを受け継ぐときにも同様で、コメントの入っていないプログラムは作業効率を下げる要因になってしまいます。

コメントは簡潔に分かりやすく

コメントを挿入する場合、不必要なコメントは邪魔になるだけですから、簡潔に分かりやすく記載することがポイントとなります。そのためプログラマーとしてはロジカルな思考だけではなく、日本語能力も養っておきたいものです。

以下のように、しっかりとソースコードに対してコメントを入れておきましょう。

宣言部・初期値代入・処理のパートを分けをしっかりする

通常プログラムは以下の三つのパートに分かれます。

• 変数の宣言
• 変数の初期値代入
• 処理

一つのモジュールの中ではこれらのパートを順番に書いていくことを心がけましょう。モジュール内で使用する全ての変数の宣言は冒頭部分で、初期値代入はその後に、それが終わってから処理を書いていくのがポイントです。処理の途中で必要な変数が出てきた場合も、かならず変数宣言パートで宣言するようにしましょう。

サブルーチンを利用する

共通処理などはサブルーチン化するなどして、できるだけメインモジュールはすっきりさせておきましょう。こうしておくことで、ソースコードが見やすくなるだけでなく、後々のメンテナンスも容易になるメリットが発生します。

余談ではありますが、こうした後々のメンテナンスを考慮することも、プログラマーとしての腕の見せ所になります。参考記事として「面倒くさがりのプログラマーほど効率の良いソースコードが書けるわけ」も併せてご覧ください。

 

おわりに

プログラミングという作業も、ただ仕様を満たして動きさえすればよいわけではありません。突き詰めれば意外と奥が深いもので、しっかりと美しく見やすいソースコードが書けることも、プログラマーとしての評価ポイントとなってきます。

プログラミングをしながらも、自分本位の考え方だけではなく、他の人が見たらどう思うのか・・という第三者目線の意識を持つようにするとよいでしょう。