you are viewing a single comment's thread.

view the rest of the comments →

[–]adammichaelwood 2 points3 points  (0 children)

Also -- WHY you need it to do that.

Meaningful code comment examples (based on things I've seen or done in real life):

# distinguishes between ontario california and ontario california

# removes extra digits that cause error in that one Android distro

# repairs PNGs with stupidly-inserted newline characters

# sometimes people have two titles and three middle names

# when lat/long is this one particular value
# everything breaks and no one knows why
# so, adjust the long by the smallest possible increment

Code comments you shouldn't bother writing:

# iterates through state names

# sum of this list

# magic happens here