Ｋ２さんの雑記

■ コメントがいるのか？

いつもはWindowsアプリケーションのメンテナンスフェーズを受け持っている常駐の外注さんが、最近組み込みのソフトウェアのデバッグをしている。

昨夜、「こんなソース読めない」とか悲鳴をあげているので、どんな汚いソースなのかと思って見てみた。私の見ているそばから、「コメントが何もないから読めない」とかおっしゃっている。

正確ではないが、そのソース（メモリチェックのベリファイ部分）を再現してみると……

  datl = (unsigned long *)sa;
  n = (ea - sa) / 4;
  for (i = 0; i < n; i++) 
  {
    wd = func();
    rd = *datl++;
    if (wd != rd) 
    {
      error_message(...
      ...
    }
  }

と、こんなところ。

これって、コメントがいるのだろうか。やっていることは明確すぎて、私などコメントがあるほうが邪魔なのだが、どうもこれでは読めないらしい。

コメントがついていることで、それを手がかりにしてソースを読むことが普通になっている人は、コメントがないとソースを解析するという頭の回路が働かないらしい。

また彼は、変数名が意味を表していないから、何を表しているかがわからないとも言っていた。彼は、普段はマイクロソフト提唱のハンガリアン記法（という表現で合っているかどうかちょっと怖いが）を使っている。どうも小文字だけの変数名に違和感を感じるらしい。

変数の意味といっても、文脈から明らかなので、これ以上長くする必要もないと個人的には思うが、例えば、datlはpulDataとか、eaをulEndAddressとか、saをulStartAddress、wdはulWriteData、rdはulReadDataと書かれていないと、もはやソースが読めない人というのが存在するようだ。

その記法は、一応いつもメンテナンスしているWindowsアプリケーションを作成する上でのチームの規約になっていたので、彼の普段の仕事では、そう書かないと規約違反になってしまう。まー、ハンガリアン記法の是々非々はおいておいて、それはそれで仕方ない。しかしその規約の中だけでやっていると、その規約に則っていないソースファイルは読めなくなってしまうのか。なんとなくわかる気はするが、ちょっと恐ろしいことだ。

しかしなー、これで「このソースひどい」とか叫ばれたら、これを書いた人は浮かばれないなー。幼稚園じゃないんだからねー。

■ [は]強い

交流戦後、セリーグの各球団はエースをびしばしぶつけてくるが、ことごとく撃破。

今年はやはり普通に強い。2003年の神懸かりとはひと味もふた味も違う。

優勝してしまうなー。