あなたが今までに読んだソースコードの中で、最高のコメントは何ですか?
What is the best comment in source code you have ever encountered?
(あなたが今までに読んだソースコードの中で、最高のコメントは何ですか?)
と言う、質問に対する答えが載っているサイトを見つけました。
» What is the best comment in source code you have ever encountered? - Stack Overflow
なかなか面白いものがありますので、いくつか引用します。
1. Hammertime!
stop(); // Hammertime!
全然、説明になってないし。(笑)
そういえば、M.C.Hammerと言うラッパーが居ました。そこからから取ってきたフレーズですね。懐かしい。最近、自己破産したってニュースを聞いたような。微妙に死後っぽいところが良い。
2. sometimes
// sometimes I believe compiler ignores all my comments
(時々、コンパイラーは、僕のコメントを無視してるんじゃないかと思う。)
ときには、コメントを理解してくれる、そんなコンパイラーが欲しい。
3. drunk
// drunk, fix later
(酔ってる。また後で修正します。)
で、まだ書き直してないと。
4. Magic
// Magic. Do not touch.
(魔法。触らないで。)
絶妙なバランスで成り立っている魔法のようなソースコードが、世の中には多々存在します。そんなときは、こう書かざるを得ない。
5. I'm sorry
// I'm sorry.
謝られても困る。なにをやらかしたんだ?
6. God only knows
//When I wrote this, only God and I understood what I was doing
//Now, God only knows
(私がこれを書いた時、神と私だけが、内容を理解した。)
(今は、神のみぞ知る。)
自分の手から離れてしばらく経つと、部分修正されて、初めに作った本人も理解できない神のみぞ知るプログラムが出来上がる事もあります。
7. should never happen
try {
} finally {
// should never happen
(決して起こってはならない)
}
「例外処理など起こるはずが無いのだ!」と言う気持ち、よく分かります。
まだまだ面白いのがあります。すぐ使えそうな物もありますね。僕もこれを見習って、人を唸らせるコメントを書いてみたいと思いました。
この記事に関連するエントリー
- 各プログラマーが見ているそれぞれのプログラミング言語のイメージ
- 色んなプログラミング言語で組んだ「Hello world!」のプログラム集
- どう発音すれば良いか迷った時に見るアスキー表
- あなたがプログラミングギークであるかを見分ける100の質問
- 力作!Perl6プログラマーの為の元素周期表風なチートシート