Object Mentor Blog: Coding Standards

Coding Standards

Uncle Bob — Wed, 18 Apr 2007 08:55:24 -0500

Coding Standards are a good idea. Every team should adopt a coding style and standard, and stick to it. The code produced by that team should have a consistent look and feel that is devoid of individual preferences and fetishes.

Of course this means that the members of the team will have to be mature enough to realize that it doesn’t really matter where they put their braces, or how they adorn their member variables. What matters is that they all use the same conventions.

Consistency

My goal for a good coding standard is to eliminate individual styles in favor of a team style. The code produced by a team should look like the team produced it. I don’t want any code recognizable as Bob’s or Bill’s.

This is not some egalitarian fantasy to hide individuality for the sake of the collective. Rather, it is a raw necessity. We’ve all seen products that look like they were designed by a committee. We’ve all used software products where the look and feel changed depending on which part of the application you were using. The result feels messy, clumsy, inefficient.

Individuals, used to their own particular style, will reformat other people’s code when forced to work on it, further shuffling the patchwork of styles. Over time, as each team member touches different parts of the code, and team members come and go from the team, the code begins to look like a jumbled Rubick’s cube of different styles.

Code is a product, in and of itself. The team producing it needs to take pride in the elegance of it’s structure, and the expressiveness of it’s presentation. This kind of pride is infeasible when the code is crisscrossed with a patchwork of individual styles. Without this pride, there is no drive to keep the overall product clean. Without that cleanliness, messes build up at the boundaries. And, as we all know, messes slow us down, and they spread.

Style not Substance

A good coding standard should be about style and form, not about substance. It should not attempt to legislate good design. It should not, for example, proscribe goto or public variables. Those rules are part of the body of knowledge that all software developers should have, and are not a matter of style.

Coding standards should be about the things that don’t matter. They should be about brace placement, naming conventions, the use of blank lines, indentation levels, etc. A coding standard should describe the way code looks, not the substance the code is made from.

It is important to keep style and substance separate because they matter for different reasons. Issues of style matter only for consistency. It does not matter whether your indent depth is 2 or 4, so long as everyone uses the same depth. It does matter if you use public variables inappropriately.

Oral/Code Tradition

Documents that describe coding standards tend to be useless. They often become a bloated battleground for many different competing ideas. My advice is to avoid writing them.

The real document that describes your coding standard is your code. If you want to know how to name a variable, look at how they are named in the code. If you want to know what the standard indent depth is, look in the code. The code is the living document that describes the coding standard.

Oral tradition plays a role as well; especially when communicating issues of substance vs. style. Teams should make use of code reviews and pair programming to communicate with each other about issues of style and substance. New members of the team should have frequent exposure to the more seasoned members, so that the issues of style and substance are inculcated with moral authority. Nothing is quite as persuasive to a young programmer than pairing with the lead programmer and hearing him say: “We don’t do things that way; we do things this way.”

The Tyranny of Tools

I have seen teams attempt to enforce a style through the use of tools. Some tools are benign and helpful. Many IDEs, for example, allow you to specify things like indent level, brace placement, etc. With a single keystroke you can ensure that a batch of code conforms to the team style. I use tools like this, an depend upon them. I make sure that all the team members set their IDEs to use the conventions.

Other tools can be more intrusive. Some tools can act like compilers, generating errors if the style is not adhered to. Such tools might be useful for an occasional scan of the code; but I think you have to be very careful if you put them into the normal build cycle.

Automatic enforcement is power; and power corrupts. We do not want a well-meaning bureaucrat deciding, one day, to enforce the style that every function argument must have a javadoc comment. This leads to comments of the form: //required comment.

This is not to say that tools like findbugs and checkstyle should be avoided. Indeed, I find them very useful. However, I think they should be run occasionally and manually, not as part of every build. The issues that these tools discover should be dealt with on a case-by-case basis.

Many tools like this allow you to insert special meta-comments that override the warnings. If these tools are placed in the build process; then the code will become cluttered with these meta-comments.

I have a pathological distaste for meta-comments.

Conclusion

Coding style is a matter of team pride and team identity. Teams should be free to adopt their own styles, and to change those styles as the spirit moves them. Each member of the team should follow the team style, and work to ensure that the body of code is a consistent statement of that style. If this sounds too artsy-fartsy, keep in mind that pride of workmanship is a powerful motivator. We want teams to be proud of their creations.

"Coding Standards" by authentic nba jerseys

Fri, 06 Jan 2012 03:48:25 -0600

Top quality, least expensive price! We’re specialized in promoting a great selection of authentic nba jerseys. Shop NBA tops at discount amount and save much money by permitting them. Sporting a piece of like your favourite players and become strong, good-looking and wholesome.

"Coding Standards" by moncler usa

Sat, 17 Dec 2011 02:15:52 -0600

Thanks your answer, it is a very good comment. So I think it is very practical for me.

"Coding Standards" by Gifts for Lesbians

Mon, 05 Dec 2011 14:44:49 -0600

Wow I am excited to be reading this, thanks

"Coding Standards" by Gifts for Lesbians

Mon, 05 Dec 2011 14:44:13 -0600

“code with a poetic vocabulary” what a great way not to code…. write a story… rest of them can listen to it!!!

"Coding Standards" by Brisbane Limo Hire

Sun, 04 Dec 2011 23:45:06 -0600

The post is written in very a good manner and it entails much useful information for me. I am happy to find your distinguished way of writing the post.Brisbane Limo Hire

"Coding Standards" by Limo Hire Brisbane

Sun, 04 Dec 2011 23:41:56 -0600

The post is written in very a good manner and it entails much useful information for me. I am happy to find your distinguished way of writing the post. Limo Hire Brisbane

"Coding Standards" by kkkz198608

Tue, 29 Nov 2011 05:35:04 -0600

Ho is wearing an Indianapolis custom NFL jersey Colts jersey, number 18, quarterback Peyton New York Giants Manning. Ho’s flag football team is one of more than 40 the NFL has set up NFL jersey custom here in recent years to spark interest.Football New England Patriots is America’s most lucrative professional sport. But selling it overseas has never been easy. The National Philadelphia Eagles Football League has slowly tried to NFL custom jerseys make inroads in, of all places, China. Yesterday, it rolled out an elaborate, custom NFL jerseys interactive exhibition in Shanghai.

"Coding Standards" by space jam jordans

Fri, 25 Nov 2011 21:36:27 -0600

space jam jordans space jam jordans

"Coding Standards" by hermes

Thu, 24 Nov 2011 01:04:41 -0600

U may be interested in our http://www.ourhermesbags.com Hermes , if u like, contact us at any time.

"Coding Standards" by music technology

Sun, 20 Nov 2011 06:35:10 -0600

The post is written in very a good manner and it entails much useful information for me. I am happy to find your distinguished way of writing the post.

"Coding Standards" by web design Hertfordshire

Tue, 15 Nov 2011 04:13:41 -0600

Quite efficient code indeed.

"Coding Standards" by beats by dr dre

Tue, 15 Nov 2011 03:51:26 -0600

A university studentbeats by dr dre caught by the enemy, the enemy tied him at the poles,just beats solo headphones purple and then asked him: say, where are you? You do not say it electrocuted! Scheap dr.dre beats studio headphones balck/yellowtudents back to the enemy a word, the result was electrocuted, he said: I am TVU.Hot sale beats by dr dre pro headphones

"Coding Standards" by christian louboutin

Fri, 04 Nov 2011 21:54:31 -0500

Christian Louboutin Rolando Hidden-Platform Pumps Golden is a fashion statement – that’s sexy, it makes you look longer highlight, and it highlights the curves in the woman body and makes the body look more elegant and thinner without any diet.

?Brand: Christian Louboutin ?Material: Golden leather ?Specialty: Signature red sole ?Color: Golden ?Heel height: Approximately 130mm/ 5.2 inches high and a concealed 20mm/ 1 inch platform ?Condition: Brand New in box with dust bags & Original Box

Fashion, delicate, luxurious Christian louboutins shoes on sale, one of its series is Christian Louboutin Rolando Pumps, is urbanism collocation. This Christian louboutins shoes design makes people new and refreshing. Red soles shoes is personality, your charm will be wonderful performance.

"Coding Standards" by christian louboutin

Thu, 03 Nov 2011 11:36:35 -0500

I like how this article is written. Your points are sound, original, fresh and interesting. This information has been made so clear there’s no way to misunderstand it. Thank you.

"Coding Standards" by christian louboutin

Thu, 03 Nov 2011 11:21:47 -0500

The professional design make you foot more comfortable. Even more tantalizing,this pattern make your legs look as long as you can,it will make you looked more attractive.Moveover,it has reasonable price.If you are a popular woman,do not miss it.

Technical details of Christian Louboutin Velours Scrunch Suede Boots Coffee:

Color: Coffee
Material: Suede
4(100mm) heel
Signature red sole x

Fashion, delicate, luxurious Christian louboutins shoes on sale, one of its series is Christian Louboutin Tall Boots, is urbanism collocation. This Christian louboutins shoes design makes people new and refreshing. Red soles shoes is personality, your charm will be wonderful performance.

"Coding Standards" by nab jerseys

Fri, 28 Oct 2011 03:08:02 -0500

I like how this article is written. Your points are sound, original, fresh and interesting. This information has been made so clear there’s no way to misunderstand it. Thank you.

"Coding Standards" by pandora bracelets ireland

Wed, 26 Oct 2011 03:40:44 -0500

This girl is really good looking.

"Coding Standards" by Tips For Bowling

Thu, 20 Oct 2011 15:45:44 -0500

I believe that at the end of the century the use of words and general educated opinion will have altered so much that one will be able to speak of machines thinking without expecting to be contradicted.

"Coding Standards" by ysbearing

Wed, 19 Oct 2011 04:30:52 -0500

Slewing ring is also called slewing bearing, some people called: rotary support, swing support. English Name: slewing bearing or slewing ring bearing or turn table bearing, slewing ring in the real industrial applications is very wide.

"Coding Standards" by best diabetes hub

Mon, 17 Oct 2011 03:54:39 -0500

I am really admired for the great info is visible in this blog that to sharing the nice approach is visible in this blog. Thanks a lot for using the nice info is visible in this blog and the nice info is visible in this blog.

"Coding Standards" by mts Convertitore

Tue, 11 Oct 2011 00:54:05 -0500

The public may not have known what the messages meant, but it helped pay for them. The skywriting stunt was supported by city and state public funding, according to the High Line’s website. MTS Convertitore “I wanted a narrative trajectory towards something optimistic at the end, which was the last message, ‘Now Open,’” she said of the work. MTS Convertitore Mac

"Coding Standards" by Cheap Moncler Vest

Fri, 07 Oct 2011 20:22:55 -0500

really great post i think that this is a nice way to work.

"Coding Standards" by herren winterjacken

Thu, 29 Sep 2011 11:47:42 -0500

I am carrying this bag myself,Herren Winterjacken when I wear very girly stuff, mine is smaller than large,herren winter still can fit lap top and all I need…I had been looking for it for several years until I found it 3 years ago in UK.Belstaff Jacken I saw it for the first time in the movie “Interpreter”, carried by Nicole Kidmann, and then in “I, Legend” carried by Will Smith.http://www.herrenwinterjacken.com/

"Coding Standards" by swarovskicry crystals

Thu, 29 Sep 2011 11:45:43 -0500

Swarovski crystal jewelry, on top of that also known as these Austrian Swarovski Crystals, is definitely the most beneficial many costly type of Crystals Swarovski uk . As a result, a majority of these Swarovski Uk items need be adopted special care involving to allow them to last perpetually.

"Coding Standards" by wellensteyn jacken

Thu, 29 Sep 2011 11:44:44 -0500

Wellensteyn-Jacken Wellensteyn werden getragen von qualitätsbewussten Menschen,Wellensteyn Jacken für die Stil und Outdoor-Bekleidung keinen Gegensatz darstellt. So sind die funktionalen Jacken mittlerweile Alltag auf den Straßen Jacken Von Wellensteyn deutscher und internationaler Großstädte.