Commenting Code with Potential Errors

Question
What should I do if the code I’m writing goes against standard practice but is intentional?

Answer
Be sure to include a comment so that other well-meaning developers don’t attempt to fix it.

Example

// Note: Assignment in loop is intentional.
while (element && (element = element[axis])) {
  if ((all || element[TAG_NAME]) && (!fn || fn(element))) {
    return element;
  }
}

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google+ photo

You are commenting using your Google+ account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s