I coin a code comment format long long ago. Over the many years that followed I've never bothered to coin a name for it, until today! I present to the world: Talented Comments!
It was late at night after spending a seemingly absurd amount of time in the coding zone. One of those winning steaks where one writes many walls of code that suspiciously lack the usual bugs and typos, draining one cup of coffee after the other... It struck me all of a sudden that very little remains of the developer after he leaves this world. All we have is the shining diamond but no collective recollection of the man who cut it. Thus Talented comments was born. It takes 3 stages, the first is a story, preferably about your early childhood, the second part is what you've learned that day (from the described experience) and the third and final stage explains to the future reader (even if it is obvious) how that lesson applies to the code below.
And then we wait, hopefully for a hundred years, for someone to find it.
Extra points if one can awkwardly name a function, class or variable to hook into the story. My gut says it will help with preservation.
It was late at night after spending a seemingly absurd amount of time in the coding zone. One of those winning steaks where one writes many walls of code that suspiciously lack the usual bugs and typos, draining one cup of coffee after the other... It struck me all of a sudden that very little remains of the developer after he leaves this world. All we have is the shining diamond but no collective recollection of the man who cut it. Thus Talented comments was born. It takes 3 stages, the first is a story, preferably about your early childhood, the second part is what you've learned that day (from the described experience) and the third and final stage explains to the future reader (even if it is obvious) how that lesson applies to the code below.
And then we wait, hopefully for a hundred years, for someone to find it.
Extra points if one can awkwardly name a function, class or variable to hook into the story. My gut says it will help with preservation.
reply