Good code is its own best documentation
Amit Shekhar
1.2K69

“Suddenly there’s a vampire! It sparkles in the sunlight.” Excellent!

Great story! I will say that most code needs some kind of explanation, like why was written, what is is supposed to do, and often, some kind of explanation of how it does that. Some (many?) algorithms that do apparently simple things can be horribly complicated. If you don’t know what the code is trying to accomplish, it can hell trying to figure it out. If you know what it’s supposed to, it can be easy. For an example, look at some sorting routines, or almost any fancy math function.