The dark ages
I used to be really big on coding standards in the late 1990's. It was so easy to slip into spaghetti code in classic ASP and VB6, and at the time, the best antidote was rigid standards and uncompromising code reviews.
I was a hard ass about our coding standards. Then, as now, the rationale was that coding standards would make the code easier to read and maintain in the inevitable and long maintenance phase.
The development process we used at the time was to stand around the white board and talk about the development tasks, then the developers would go off and separately code it up. That was the other reason the coding standards mattered - we didn't want two code files to look totally different if written by different developers.
My teams used the naming conventions Microsoft came up with for Access/VBA/VB, including Hungarian notation prefixes, but a lot of the standards were about code comments, error handling code, whitespace and indenting, etc.
.NET comes on the scene
Fast forward maybe 5 or so years to the introduction of .NET and C#, and coding changed. ASP.NET HTML didn't require <% %> tags anymore. We could put the C# in code behind files and other project files. We didn't need On Error anymore, we had Try-Catch. XML comments seemed like a cool feature to show Intellisense drop downs for code you wrote in addition to framework Intellisense.
So we updated our coding standards to reflect the language and IDE changes, but they became more like guidelines instead of hard and fast rules. By convention, we would avoid the spaghetti code just by keeping the right code in the right place. Hungarian notation went away (slowly but surely). The coding standards document was mostly reference code snippets and justifications for the conventions we used. Code reviews became less common because it wasn't as big of an issue.
A lot has changed since .NET first came out, and I code differently now. I'm trying to make my code a lot more terse these days. I'm a big fan of having clean, succinct, expressive code. The fewer non-essential things on the screen to wade through, the better. It's more readable and easier to refactor.
- I could put Try-Catch blocks everywhere, but isn't it simpler to catch unhandled exceptions in one place.
- I could add XML comments, but why? It's either code in my same web project or a project that is owned by my solution. I don't usually work on common library code where an assembly will be used across projects and Intellisense might be needed.
- I don't put the variable type on the left side of the equal sign anymore and use "var" instead.
- I've walked away from code regions and just order the items in the class file by convention. ReSharper likes to put new fields under the last field declaration in the class, so region wrapping all the fields in a class with "#region Fields" just wastes time when refactoring to pull it back up into the region.
Not only has the way I code changed, but the tools have changed. ReSharper code cleanup templates and StyleCop warnings can be used to keep your team writing code in a style that you've all agreed on. Just run the tool and have it clean up the code for you or flag code that doesn't meet the style guidelines.
Having tests around the code lets me refactor and use auto-code-cleanup tools freely. I understand the project a little more fully every day, so I can rename my class, method, and variable names to be more descriptive and accurate without worrying about breaking code.
I'm also doing more pair programming these days, and this is a good way to enforce and socialize team coding styles. It also means we don't have to refer to a coding standards document as often. Since we're more story-focused, we're thinking more about the feature and less about coding style. Taking ceremony code off the screen helps us keep that focus.
If I had to do it over
If I was going to write a coding standards document today, it would be more like a style guide to reflect my current less-is-more thinking, and I'd probably give my peers a ReSharper template to auto-clean their code as they go instead of a document to refer to. StyleCop for ReSharper looks promising as a gentle background reminder of team coding styles.
What about your team? Do you have a coding standards document people refer to? Do you use tools to enforce standards/styles?
About Volare Systems
We build high quality web and mobile web apps that run fast and look great on every device . We are based in Denver, Colorado . Let us know if we can help your company with custom software development or web application development.
We hope this blog post was helpful . If so, please share it using the social toolbar on this page so others can find it. Thank you .