Endowsの日記: Endows の コンピュータ三昧 第11回 2
日記 by
Endows
今回は珍しくお仕事関連の話。といってもまだどこまで秘密にしなきゃならないかすら分からないので、あたり障りの無いところだけ。
最近他人の書いたソースをいじる機会が何度かあったんですが、それで思ったこと。
『たのむから、コメントとかドキュメントは出来るだけ残してください(泣)』
まーどれも見るからに色んな人の手が入っているソースっぽかったんですが、使われてない変数や定数が残ってたり変数がどんな目的で使われてるのか一見して分からなかったり変数名が妥当でなかったりなんてのが当たり前にあったりするんですねぇ。
今、自分が書き換えたソースのドキュメントなんか作ってたりするんですが、そこまで詳細なドキュメントでなくても「これがどこかにちょこっと書いてあったらソース解読に費やす時間が大幅に減ったはずだよなぁ」というのがいくつもあるのです。
( ちなみに自分が書いたドキュメントの方は、逆に詳細過ぎる上に章立てが上手くなくて、どこから読んで良いか分からない代物になりそうな気も… 閑話休題 )
1回書けば終わり、保守の必要すらないというソースなんて(多分)無いんだから、他人が解読する手助けになるものは残して欲しいと思ったのでした。
そんなわけで、適切な変数名を考えるためだけに常に電子英和・和英辞典を持ち歩いている Endows です。
-- 追記 --
えぇ、昔はコメントを書かない主義でした。昔は。
考えをあらためるには十分すぎる時間が経ったのです。
…ということを、誰に突っ込まれるでもなく補足しておく。
たまに見かけるコメント (スコア:1)
何か言いたかったらしいことは分かるけど、何を言いたかったんだろ?
まあ、注目を引くぶん、何も書かないよりはまし…?
さらに困るのが
/* なんとなく */
とか
// とりあえず
とか。
いや、なんとなくって言われても…
巧妙に潜伏したバグは心霊現象と区別が付かない。
Re:たまに見かけるコメント (スコア:1)
いやいや、これはおおいに役に立ちますよ。「『なんとなく』なのか、じゃあそんなに重要な値じゃないな」という感じで、どんな処理をしているのか見るときとかは流し読み程度にしたり。
/* んで、そんなのが重要な変数になってたりしてびっくり、というオチもあるかも。 */