Skip to content

Instantly share code, notes, and snippets.

@schnogz
Last active November 16, 2016 06:13
Show Gist options
  • Save schnogz/920378ec67162956fd33 to your computer and use it in GitHub Desktop.
Save schnogz/920378ec67162956fd33 to your computer and use it in GitHub Desktop.
Top 15: Best source code comments
======================================================
// The magnitude of this hack compares favorably with that of the US national debt.
======================================================
// Warning: Thar be dragons lurkin and black magic at work here.
// Modify at your own risk!
//
// ^ ^
// |\ \ / /|
// / \ |\__ __/| / \
// / /\ \ \ _ \/ _ / / \
// / / /\ \ {*}\/{*} / / \ \
// | | | \ \( (00) ) / // |\ \
// | | | |\ \(V""V)\ / / | || \|
// | | | | \ |^--^| \ / / || || ||
// / / / | |( WWWW__ \/ /| || || ||
// | | | | | | \______\ / / || || ||
// | | | / | | )|______\ ) | / | || ||
// / / / / / /______/ /| \ \ || ||
// / / / / / /\_____/ |/ /__\ \ \ \ \
// | | | / / /\______/ \ \__| \ \ \
// | | | | | |\______ __ \_ \__|_| \
// | | ,___ /\______ _ _ \_ \ |
// | |/ /\_____ / \ \__ \ | /\
// |/ | |\______ | | \___ \ |__/ \
// v | |\______ | | \___/ |
// | |\______ | | __/
// \ \________\_ _\ ____/
// __/ /\_____ __/ / )\_, _____/
// / ___/ \uuuu/ ___/___) \______/
// VVV V VVV V
======================================================
// after hours of consulting the tome of google
// i have discovered that by the will of unknown forces
// without the below line, IE7 believes that 6px = 12px
======================================================
// If you're reading this, that means you have been put in charge of my previous project.
// I am so, so sorry for you. God speed.
======================================================
// And now for my final trick, getting all of that to look
// half decent in the retarded step brother of the browser family
// Internet Fucking Explorer!
======================================================
// uncomment the following line if the program manager changes her mind again this week
======================================================
// deep wizardry. do not touch.
//
// no seriously. Brian, I'm looking at you. If you screw with this again
// I will kill you with my swingline stapler.
======================================================
// Dear maintainer:
//
// When I wrote this code, only I and God
// knew what it was.
// Now, only God knows!
//
// So if you are done trying to 'optimize'
// this routine (and failed),
// please increment the following counter
// as a warning to the next guy:
//
// total_hours_wasted_here = 67
======================================================
// 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.
======================================================
// I dedicate all this code, all my work, to my wife, Darlene, who will
// have to support me and our three children and the dog once it gets
// released into the public.
======================================================
// somedev1 - 6/7/02 Adding temporary tracking of Login screen
// somedev2 - 5/22/07 Temporary my ass
======================================================
// You may think you know what the following code does.
// But you dont. Trust me.
// Fiddle with it, and youll spend many a sleepless
// night cursing the moment you thought youd be clever
// enough to "optimize" the code below.
// Now close this file and go play with something else.
======================================================
// This isn't the right way to deal with this, but today is my last day, Ron
// just spilled coffee on my desk, and I'm hungry, so this will have to do...
======================================================
// this comment included for the benefit of anyone grepping for swearwords: shit.
======================================================
// TODO: fix later. this is crap code but it's 3 a.m and I'm drunk.
======================================================
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment