Posted by Vincent Partington just before lunchtime: October 13th, 2006
In quite a few coding standards I have seen a guideline saying all local variables must be initialized at declaration. No doubt the authors were copying from, erm, inspired by Sun’s Java coding standard guideline 6.2 which says
Try to initialize local variables where they’re declared. The only reason not to initialize a variable where it’s declared is if the initial value depends on some computation occurring first.
Sounds all nice and dandy. What could be wrong with that?
Well, the result of this guideline is that a lot of developers who can’t think of a useful value to initialize their variable with decide to initialize it with null instead of leaving it unitialized. This has the nasty property of not catching a lot of NullPointerExceptions that would have resulted in a compile time error along the lines of “The local variable x may not have been initialized” if the developer had just left that variable uninitialized instead.
It’s a pity Sun recommends such silly things which were probably inspired by the C/C++ era when uninitialized variables would contain garbage. Then again, Core J2EE Patterns is still in print while nearly all of the patterns described in it are either outdated or wholly inappropiate by now. But more on that later…
To me the sun standards recommend that the declaration of a local variable should be moved to where it is first assigned (initialized). This way the variable is _always_ initialized with a correct value.
Only if this is not possible (for example, due to some computation that cannot be extracted into a separate method) would you declare a local variable without initializing. Like you said, assigning “null” or some other random value is a bad thing in this case since the compiler is no longer able to help you avoid errors.
Exactly. Instead of Try to initialize local variables where they\’re declared it should have said Try to declare local variables where they\’re initialized. Then the compiler could prevent a lot of these initialization problems instead of users getting an NPE at runtime.
Regards, Vincent.
Consider the following code I often see:
void ...(...) { object o = null; object o = DoSomething(...); if (object != null) { ... } }It’s a stupid double assignment. The DoSomething method assigns to variable because it always returns a value or throws an exception.
It’s a case where the compiler could easily outwit the *programmer*.