可読性を高めるプログラムの書き方

プログラムを書くとき、可読性が高いプログラム方がそうでないプログラムより評価が高く、メリットしかありません。

その理由と可読性を高める方法を紹介します。

可読性が高いプログラムのメリット

可読性が高いということは、このプログラムは、どういう処理をするプログラムなのか分かりやすいということです。

第3者にプログラムを見てもらう場合、可読性が高いことに越したことはないです。

また、自分しか見ないから大丈夫だと思っても、しばらく時間が経ってそのプログラムを見ると何が何だか分からなくなります。時間の無駄です。

したがって、可読性の高いプログラムを書くことは非常に重要です。

方法

では、プログラムの可読性を高めるには、どうすればよいでしょうか。

自分なりに４つのポイントにまとめました。

インデント

インデントとは、字下げのことであり、プログラムの構造を見やすくするために制御構文の内側にある行などの先頭に一律に同じ幅の空白を挿入することです。

インデントなし(Fortran)

implicit none
integer::x=11,y=0

if (x<10)then
x=x+1
y=y+1
else
x=0
endif
write(*,*)x
stop
end

インデントあり(Fortran)

implicit none
integer::x=11,y=0

if (x<10)then
    x=x+1
    y=y+1
else
    x=0
endif
write(*,*)x
stop
end

また、Pythonではインデントでブロックを判断するので、正しくインデントする必要があります。

変数名

プログラムを書く際、必ずと言っていいほど変数を使うと思います。

その変数の名前は、基本的になんでも指定できます。例外として数字から始まる変数はダメです。

なんでも指定できますが、可読性を高めるためには、何の変数か分かりやすい変数名にするべきです。

例として、時間の変数ならtimeとかですね。

また、1文字の変数名は、極力避けるべきです。なぜなら、変数を検索するときに、変数ではないものもヒットしてしまうからです。

ですので、変数名は、何の変数か分かりやすい英単語、またはそれを省略したもの　かつ　2文字以上の変数名にするべきです。

コメントは、プログラムの処理を理解する際に手助けします。

メモと思ってもらって大丈夫です。コメントは、プログラムの後ろとかに書くのではなく、改行して1行文使いましょう。

プログラム言語によっても方法は異なりますので、各々調べてください。

余白

プログラムを書く際、余白を途中で入れることでプログラムを読みやすくなります。

例を紹介します。

余白なし(Python)

im=ax.pcolor(f,cmap='jet',norm=LogNorm(vmin=min,vmax=max))
pp=fig.colorbar(im,orientation='vertical',extend='both')
ax.set_xticks(np.arange(0,cut,1)+0.5,minor=False)
ax.set_xticklabels(np.arange(0,cut,1),rotation=45,minor=False)
ax.set_yticks(np.arange(0,cut,1)+0.5,minor=False)
ax.set_yticklabels(np.arange(0,cut,1),minor=False)

余白あり(Python)

im = ax.pcolor( f, cmap='jet', norm = LogNorm( vmin=min, vmax=max ))
pp = fig.colorbar( im, orientation='vertical', extend='both' )
ax.set_xticks( np.arange( 0, cut, 1 ) + 0.5, minor=False )
ax.set_xticklabels( np.arange( 0, cut, 1 ), rotation=45, minor=False)
ax.set_yticks( np.arange( 0, cut, 1) + 0.5, minor=False )
ax.set_yticklabels( np.arange( 0, cut, 1 ), minor=False )

余白があった方がない方より読みやすいと思います。

余白がないと窮屈で読みづらいです。ですが、なんでも全てに余白すればよいという話ではないです。

規則性を持った余白を入れましょう。