Geek Etiquette » Programming http://geeketiquette.com Emily Post for the digital generation. Fri, 04 Apr 2008 21:52:24 +0000 http://wordpress.org/?v=2.9 en hourly 1 Coding manners matter http://geeketiquette.com/archives/2007/08/10/coding-manners-matter/ http://geeketiquette.com/archives/2007/08/10/coding-manners-matter/#comments Fri, 10 Aug 2007 19:39:23 +0000 Skud http://geeketiquette.com/archives/2007/08/10/coding-manners-matter/ I was thinking the other day about coding standards, and what’s considered good coding practice. Let’s consider a handful of examples:

  • neatly laid-out code (indentation, line length, etc)
  • informative variable names
  • inline documentation/comments

When we work in coding teams we tend to hammer this into people. Most software projects have a “house style” of some sort, to which all contributors are expected to adhere. Newcomers sometimes take some convincing, but most get there in the end.

We usually say that we have coding standards and style guides because it improves code quality, or makes the software easier to maintain. That’s certainly true. But it occurred to me a while ago that coding standards are also a matter of etiquette.

By conforming to a coding standard, we smooth our interactions with the rest of the team.

That one guy who always uses tab characters, or names his variables LikeThis instead of like_this, isn’t just making the code worse; he’s driving everyone else nuts with his rudeness.

]]>
http://geeketiquette.com/archives/2007/08/10/coding-manners-matter/feed/ 7