notes by karl fleischmann RSS 2.0
# Tuesday, July 21, 2009

So my first step in understanding .Net coding standards is to understand what’s out there. So time to use the handiest tool available, Web Search (Google and Bing). WOW! Maybe it’s just the way I chose my words, ok so it always has to do with that, but searching on “.Net Coding Standards” returned over 30 million hits on Bingand 417,000 on Google.

Ugh, where’s my coffee? Ok time to narrow it down because I’m not crazy. Let’s just focus on the to some of the top ones. I like ones that are formatted for HTML or in a downloaded document. I’m also looking for more complete ones, not ones that just focus on one topic of the standards. Remember, I’m not here to invent the wheel, just to find the best ideas for designing and constructing a wheel. Then to understand each aspect of the wheel to determine why it’s important to have that standard. Here we go…

We probably need to start with the big one. The one from Microsoft. Design Guidelines for Class Libraries.

Clint Edmonson has a post on NotsoTrivial.net containing free VB & C# coding standards. I like his quote…

"It doesn't matter what the standards are, as long as you have them and everyone agrees to adhere to them!"

Lance's Hunts Whiteboard has a C# specific download.

For those of you that have spare cash and don’t want to pollute the air with the ash from burning it, you can buy one from CafePress.com I think I’ll stick to the free ones, especially after reading this.

Michael Flanakin has one that is pretty decent set of standards on his blog, but I just wish there was an index so I could jump between the sections.

A quick scan shows this one by Paul Yao and David Durant, shows great detail in the use of Hungarian format. That will come in handy I’m sure when we get to that section.

And finally some insight on internal coding standards from Brad Abrams at Microsoft

Ok that gives us a pretty good list. I’ll use/refer to the above as well as some of my internal corporate documents as we work my way through this arduous task. Let’s dig in, and ask a lot of questions.

Happy Moon Landing!



Tuesday, July 21, 2009 6:54:44 AM (Eastern Standard Time, UTC-05:00)  #    Comments - Trackback
.Net Standards | C# Standards | Coding Standards
# Thursday, July 09, 2009

I’m on a project where the coding quality has been in question and there has been a lot of scrutiny on the coding style and format of our code.  Our customer has a set of general set of coding standards that they require all suppliers to follow.  We as a .Net team also have our own set of standards.  Probably every where you go you’ll find similar coding standards documents.  Some people have even adopted personal coding standards. Do you have any?  Do you hold your code to a set of standards? Are they documented?

How many of us really know our coding standards?  How many of us follow them or work to improve them?  Are your standards documents just some bytes taking up disk space on your network or SharePoint site?  Frankly, this exercise with our customer has made me ask myself, how much do I really follow the standards? 

Today I’m beginning a challenge for myself.  A challenge to re-read our coding standards, research other industry coding standards and to understand the reasons behind them and to determine which of them make sense and which don’t and to understand why.  I will try to include some of my knowledge here on my site, for my reference and possibly yours, my friend.  Let’s do this together, if anyone’s out there.  Let’s understand why we have standards and fix the ones that are just wrong.



Thursday, July 09, 2009 9:50:24 PM (Eastern Standard Time, UTC-05:00)  #    Comments - Trackback
.Net Standards | C# Standards | Coding Standards
Product Spotlight
Subscribe to updates of 'And Many Lines to Code...' by Email
Archive
<February 2012>
SunMonTueWedThuFriSat
2930311234
567891011
12131415161718
19202122232425
26272829123
45678910
About the author/Disclaimer

Disclaimer
The opinions expressed herein are my own personal opinions and do not represent my employer's view in any way.

© Copyright 2008-2012
Karl D. Fleischmann
Sign In
Statistics
Total Posts: 45
This Year: 0
This Month: 0
This Week: 0
Comments: 2
Hosting Provider


All Content © 2008-2012, Karl D. Fleischmann
DasBlog theme 'Business' created by Christoph De Baene (delarou)