你在源代码中遇到的最好的评论是什么？

Question

你在源代码中遇到的最好的评论是什么？你在源代码中遇到的最好的评论是什么？

Answer 1

我对此感到特别内疚，在我的大多数项目中嵌入了非建设性的评论、代码诗和一些小笑话(尽管我通常有足够的理智在发布代码之前删除任何直接冒犯的内容)。这里有一个我特别喜欢的，放在一个设计很差的“上帝物体”下面。

/**
* For the brave souls who get this far: You are the chosen ones,
* the valiant knights of programming who toil away, without rest,
* fixing our most awful code. To you, true saviors, kings of men,
* I say this: never gonna give you up, never gonna let you down,
* never gonna run around and desert you. Never gonna make you cry,
* never gonna say goodbye. Never gonna tell a lie and hurt you.
*/

对不起！我只是忍不住…！

另一种，我承认我并没有真正放生到野外，尽管我是非常我很想在我的一个不那么直观的类中这样做：

// 
// Dear maintainer:
// 
// Once you are done trying to 'optimize' this routine,
// and have realized what a terrible mistake that was,
// please increment the following counter as a warning
// to the next guy:
// 
// total_hours_wasted_here = 42
//

Answer 2

Exception up = new Exception("Something is really wrong.");
throw up;  //ha ha

Answer 3

//When I wrote this, only God and I understood what I was doing
//Now, God only knows