ソフトウェア開発201の鉄則 原理105:コーディング: プログラムの体裁を整えよ

要旨

* プログラムの読みやすさ、理解しやすさは、インデントを整えることで大きく改善される
* コーディングルールを適用しよう。どれを選んでもいいが、決めたら一貫して使おう
* 一貫性のないインデントもよくないが、さらに、「間違った」インデントは理解の間違いなどの悪影響を及ぼす
* 整ったインデント、見てインデントの状態がわかりやすいエディタ、ツールを活用せよ

解説

if 文のような分岐があるもののロジックを、ソースコードを眺める開発者は、コードの開始位置、つまりインデント位置で追いかけている。

なので、インデントがおかしいと、ロジックを誤って判断することに、なりかねない。

プログラムの体裁を整えるためには、コーディングルールを決めて従う、ということが必要。

コーディングルールを決めることには、時間をかけなくていい。今の時代、そういうのはドキュメントを含めてカンタンに入手できるので、活用すればよい。

大事なのは、それを守ることと、一貫性を保つこと。どちらも、継続して実行するのが難しいが、

* 常にコーディングルールを意識しよう
* コーディングの支援をしてくれるツール、エディタを活用しよう
* 定期的に自分のコードを見直そう
* コードレビューをしよう

この原理の実行のためのアクションは、こんなところか。

この原理、最後の文章は、

インデントを整えるために、市販のよいプリンタを使うことを勧める

というもの。さすがに今の時代それはないだろう（笑

インデントを整えて体裁のよいプログラムを書くには、Visual Studio Code を活用しよう

ですね。