in reply to On Coding Standards and Code Reviews
I guess it may be just me, but I'm curious as to why. Some of your suggestions/commandments are purely arbitrary, and I don't use that in a negative light as sometimes there is no best choice and consistency is more important, but I'm still curious as to why you chose that arbitrary rule over another similarly-weighted controversial rule.
Just to pick on the first one that popped out, using spaces over tabs. Don't get me wrong, I agree with it, but I know it's contentious, and would prefer to see something that expanded on why. This goes doubly, if not more, if you're going to need to not just defend your rules against peers in your organisation, but against every single new hire for the rest of your tenure there. It also allows the rules to be properly challenged if, for example, the significance of your decision is reduced.
As an example, continuing to pick on the spaces vs tabs, perhaps it is desirable for each developer to use the tools they're most comfortable with. That may mean some of your developers using eclipse, others using emacs, others using vi, and the odd wacko using notepad, as long as each is highly productive. But then, perhaps your management (either personnel or technical) decides for some reason to standardise on an environment - whether that's MS Visual Studio, Eclipse, or Komodo. Now maybe the reason for spaces goes away, and it can be revisited. But without a continued, on-going understanding of the reasoning, your rules become unchallengeable shackles or cargo cult, possibly long outliving their usefulness.
I know you have lots of links, but, without going through each one manually, it's difficult to know (in general) which link defends which rule. Some are obvious, but not all, so you should still have as direct of links as possible for most items.
My second suggestion would be to store the whole thing in a corporate wiki where others can add their reasons for (or possibly even against) each dictum, making it (hopefully) feel less like dictum, and more like group selection, and thus easier to self-enforce. It also would help keep the document living which helps it stay in use, as well as keeps it available for challenge.
|
---|
Replies are listed 'Best First'. | |
---|---|
Re^2: On Coding Standards and Code Reviews
by eyepopslikeamosquito (Archbishop) on Feb 19, 2009 at 06:51 UTC | |
by puudeli (Pilgrim) on Feb 19, 2009 at 08:21 UTC | |
by eyepopslikeamosquito (Archbishop) on Feb 19, 2009 at 09:40 UTC | |
by puudeli (Pilgrim) on Feb 19, 2009 at 10:39 UTC | |
by Mr. Muskrat (Canon) on Feb 19, 2009 at 15:45 UTC | |
by JavaFan (Canon) on Feb 19, 2009 at 22:57 UTC | |
by puudeli (Pilgrim) on Feb 20, 2009 at 07:03 UTC | |
by ruzam (Curate) on Feb 20, 2009 at 03:11 UTC | |
by Tanktalus (Canon) on Feb 22, 2009 at 15:00 UTC | |
by dk (Chaplain) on Feb 24, 2009 at 12:45 UTC |