プログラミング講座(18) コメントの見直し

単語帳プログラムのチューニングも一段落したので、デバッグ（虫取り）で追加した部分を取り除きながら、コメントを見直してみます。

書きなおしたプログラムはプログラムID BKM132で「発行」しましたので、「インポート」でこのIDを指定すればダウンロードできます。ただし、例によって

26 ' The following line could be harmful and has been automatically commented.
27 ' line = File.ReadLine(filename, lno)

51 ' The following line could be harmful and has been automatically commented.
52 ' line = File.ReadLine(filename, lno)

のとおり、File.ReadLine()の行がコメントになっているので、シングルクォーテーションを削除してください。

コメントを見直してみて、コメントの間違いもありました。プログラムも If-Then-Else-EndIf で条件を <> で記述するより = で記述したほうが自然だというところがありました。

プログラムを書いて1年後に読むと、他人の書いたものを読むのと同じ状況になります。何を意図しているのか、プログラムからは読み取りにくい内容はコメントとして残しておくことをお勧めします。プログラム作成中はデバッグに夢中になってしまい、コメントのことは後回しになりがちですが、最初にお伝えしたような疑似コードのようなものを残しておくと有用だと思います。

プログラミングの心得については、『プログラム書法』という本がとても参考になると思います。この連載でも大いに参考にしています。

これで単語帳プログラムについては連載を終りにしたいと思います。

（つづく）