Tuesday, January 31, 2006
Non-coders can safely ignore this one. I just needed to document it. Pun not intended, but enjoyed and allowed to remain.
I'm plowing through a client's large PHP script to convert the output from HTML to PDF. The formatting is generally awful, with indentation all over the place and unneccessary code tossed about like an excited Shriner firing candy at a parade crowd. Sure, it's fun to watch, but you won't ever watch anything again if a piece hits you in the eye.
I digress.
Source code is the human-readable language that programmer's write that in-turn becomes a piece of software through various means. Good programmers will add comments to their source when it is unclear why they are doing something or even what they're doing at all.
Today I ran across the following helpful source comment:
//store a character in a variable.
This is similar to a movie review going this way:
//there was an actor in a plot.
Alright, back to work.
I'm plowing through a client's large PHP script to convert the output from HTML to PDF. The formatting is generally awful, with indentation all over the place and unneccessary code tossed about like an excited Shriner firing candy at a parade crowd. Sure, it's fun to watch, but you won't ever watch anything again if a piece hits you in the eye.
I digress.
Source code is the human-readable language that programmer's write that in-turn becomes a piece of software through various means. Good programmers will add comments to their source when it is unclear why they are doing something or even what they're doing at all.
Today I ran across the following helpful source comment:
//store a character in a variable.
This is similar to a movie review going this way:
//there was an actor in a plot.
Alright, back to work.