Wednesday, 21 November 2012

Does your code communicate with other Dev's?

In a team atmosphere, the personal nature of coding style is a challenge. 

The following example might explain the importance of coding style:

"The situation of a group of musicians trying to form a band. Each one comes in believing that their way of doing things is best (their "method" or "process"). The band will struggle so long as everyone is trying to do their own thing. It's impossible to create good music unless everyone in the band agrees on the tempo, the style and who should take lead during a song. Anyone who has ever heard a high school band perform knows this to be true. Unless everyone is on the same page, you aren't going to accomplish much."
Thus, we should start following a style guide. Following are the few style guides that I have in my list and I try to follow them.
  1. http://docs.jquery.com/JQuery_Core_Style_Guidelines 
  2. http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml 
  3. http://google-styleguide.googlecode.com/svn/trunk/htmlcssguide.xml
  4. https://github.com/necolas/idiomatic-css 
  5. https://github.com/styleguide/ 
  6. http://msdn.microsoft.com/en-us/library/ms229042.aspx  Microsoft - Design Guidelines for Class Library Developers.
  7. http://www.idesign.net/idesign/download/IDesign CSharp Coding Standard.zip  IDesign C# Coding Standard.
  8. http://www.danrigsby.com/Files/csharpcodingstandards.doc Dan Rigsby C# Coding Standards.
  9. http://submain.com/products/guidelines.aspx SubMain C# / VB.NET Coding Guidelines.
  10. http://weblogs.asp.net/lhunt/archive/2004/08/17/CSharpCodingStandardsv113.aspx Lance Hunt - C# Coding Standards.
  11. http://www.dotnetspider.com/tutorials/BestPractices.aspx  DotNetSpider - C# Coding Standards and Best Programming Practices.
  12. http://msdn.microsoft.com/en-us/library/67ef8sbd.aspx Microsoft - C# Programming Guide.
  13. http://www.tiobe.com/content/paperinfo/gemrcsharpcs.pdf Phillips Medical Systems - Coding Standard C#.
You can opt one and start extending it. Also, you might also have some experience or resources under your arsenal :D which you can share with team members.

No comments:

Post a Comment

Search...