リスト１−１には、コメントは入っているのですが、あまり効果的ではありません。
一番困るのは、関数の始まりが、すぐには分からないことです。関数の始まりは、プログラムで 一番重要なところなので、できるだけ目立つように、最低でも
/************************************************************************/ /* ＭＥＬＳＥＣの呼び出し */ /************************************************************************/
という感じにしたいものです。大きなプログラムを多人数で開発するときなどには、関数名、機能 説明、引数の説明、注意事項などをきれいに書いておくと、後で見たとき、この関数はどういう関 数だったかすぐに分かります。そして、再利用でき、生産性も向上します。
関数の先頭が分からないのに、関数の途中のコメントが、行の先頭から始まっていて、まるでコ メントの位置で関数が切れるように感じられます。特に１７０行、２１６行のコメントはそうです。 このようなコメントは、他の部分と同様に「字下げ」をしたほうが意図がよく分かります。
たぶん、このプログラムを書いた人は、関数が長くなり過ぎ、実行部の開始位置、データ書き込 み部分、データ読み込み部分が分からなくなって、目立つコメントを入れたのでしょう。でも、そ れは本末転倒です。関数を短くすれば、こんな目立つコメントの入れ方は不要だったでしょう。
自分の書いたプログラムで、書いているときは良く分かっていても、後で見ると全然分からない ことがあります。それどころか、「だれだ、いったいこんなプログラムを書きやがって！」と思っ て調べてみると、自分のプログラムだったりするものです。
「急がば回れ」です。コメントを書く時間を惜しむと、他でもっと時間を無駄にしてしまいます。
それから、staticの場合には、グローバルな関数のようには目立たない方が良いので、私は
/*---------------------------------------------------------------------*/ /* static関数の頭のコメント */ /*---------------------------------------------------------------------*/
の様にしています。
オープンソース
Scheme言語処理系
Gaucheの愛好者団体
