What is the best comment in source code you have ever encountered? -


what best comment in source code have ever encountered?

i particularly guilty of this, embedding non-constructive comments, code poetry , little jokes of projects (although have enough sense remove directly offensive before releasing code). here's 1 i'm particulary fond of, placed far, far down poorly-designed 'god object':

/** * brave souls far: chosen ones, * valiant knights of programming toil away, without rest, * fixing our awful code. you, true saviors, kings of men, * this: never gonna give up, never gonna let down, * never gonna run around , desert you. never gonna make cry, * never gonna goodbye. never gonna tell lie , hurt you. */ 

i'm sorry!!!! couldn't myself.....!

and another, i'll admit haven't released wild, though very tempted in 1 of less intuitive classes:

//  // dear maintainer: //  // once done trying 'optimize' routine, // , have realized terrible mistake was, // please increment following counter warning // next guy: //  // total_hours_wasted_here = 42 //  

Comments

Popular posts from this blog

c++ - How do I get a multi line tooltip in MFC -

asp.net - In javascript how to find the height and width -

c# - DataTable to EnumerableRowCollection -