ソフトウェア工学について その3(4) 空行の使い方について

今日はこじんまりとした話題になるが空行について話をしたい。
空行とは文字の通り空白の行である。
プログラムのドキュメント化を行う当たっては空行も大切な要素である。
空行はコーディングをするにあたっての1つのブロックの切れ目を表現することを可能にする。
文章でいえば、段落の切れ目を表現することが可能だ。

先日話をしたコメントとこれを上手に組み合わせるととてもわかりやすいソースを書くことができるようになる。

たとえば、下記のプログラムを見てほしい。

リスト1　空行がない例   // 文字の入力   int result = scanf("%s",&b);   // 入力された文字列が"string"であるかを比較する   while( a[pos] != 0 && b[pos] != 0 ){     if( a[pos] != b[pos] ){       // 内容が異なっている場合は結果をfalseにする       r = false;       break;     } // if   }

この場合はそもそも母体が小さいので容易かもしれないが、とくに行コメント（1行丸ごとコメントであるものを指す）を行った際はその段落単位で空行を入れると非常に見やすくなる。

リスト２ 適切な空行が入った例   // 文字の入力   int result = scanf("%s",&b);   // 入力された文字列が"string"であるかを比較する   while( a[pos] != 0 && b[pos] != 0 ){     if( a[pos] != b[pos] ){       // 内容が異なっている場合は結果をfalseにする       r = false;       break;     } // if   }

上記リスト２のようにすると「//文字の入力」とある個所はどこまでのロジックを指すのか。
入力された文字の比較をしているのはどこまでなのか等を見分けるのが容易になるかと思う。

このようにちょっとした工夫を積み上げることによってソースは一段と可読性を上げることができ、ドキュメント性が増す。