Spell Check Your Code (Funy Storie)

Before I tell this story I must admit that without Spell Check I never would have graduated college.  It is not because I mistyped words, I am a horrible speller!
 
I recently developed a solution allowing SharePoint KPIs to be associated with GeoRSS polygons.  The solution also leveraged IDV Solutions (www.idvsolutions.com) Visual Fusion Suite as the map display and region creation tool.  The KPI would be used to determine the color of the region when it was activated on the map.  This required me to perform the KPI calculations for the dynamic KPIs, could not find any method of getting the dynamic value.  One of the dynamic calculations is to find the Minimum value of the items in the list…simple enough.  I developed the code and tested, fixed a few bugs and then set it on to our tester.  While our tester was looking at the tool another developer performed a code review and remarked that I had misspelled "Minimun" in the code.  So I went back and fixed the issues from the code review and redeployed for our tester.  Next day I spoke with the tester and several tests had all of a sudden begun to fail!  This was very strange because most of the code review comments had been violations of our variable and method naming schema, code compiled so all of that should have been working…
 
After using U2U’s CAML viewer I discoverd I hadn’t misspelled Minimun, SharePoint actually uses Minimun!  Of course the value in the User Interface is spelled Minimum.
 
Moral of the story, spell check your code.  I have been told this before in software development classes and seminars, and never really understood, cared, or ever did it.  I understand now, that simple spelling mistake can really cause issues for others using your code.  Worse it can cause you problems later in your code when you actually spell that variable name correctly.
Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s