Channels ▼
RSS

Tools

Bug Opportunity Levels



If every piece of code worked perfectly the first time, programming would be an easy job. Sadly, that is not the case. In any large project, you will probably spend more time testing, tracking down bugs, and figuring out how to fix them than you spend writing the code in the first place.

Dealing with bugs is an unavoidable part of writing software, but there are things you can do to make the job easier. At every step of the process, you make decisions which influence the risk of creating bugs later on. Experienced programmers understand this and intentionally write their code in a way that minimizes the opportunities to make mistakes. This is sometimes known as "defensive programming".

In this article I make this practice a little more systematic by presenting a taxonomy of "bug opportunities" -- situations in which it is possible to make a programming mistake. I categorize them into five levels, based on the time and effort needed to identify the mistake. And I give examples of each level, and suggests strategies for turning the more severe levels into less severe ones.

A bug opportunity is not the same as a bug. With enough caution, even a minefield can be successfully navigated. But you will make mistakes from time to time, and the more opportunities you have for mistakes, the more mistakes you will end up making. A key to writing bug-free software is therefore to avoid situations in which you might make a mistake; or when that is not possible, to choose your risks carefully so that bugs will be found and corrected as quickly as possible.

Most of the examples in this article are in Java, and I assume familiarity with the Java language. None of the principles are Java specific, however, and they apply just as well to almost any other language.


Related Reading


More Insights






Currently we allow the following HTML tags in comments:

Single tags

These tags can be used alone and don't need an ending tag.

<br> Defines a single line break

<hr> Defines a horizontal line

Matching tags

These require an ending tag - e.g. <i>italic text</i>

<a> Defines an anchor

<b> Defines bold text

<big> Defines big text

<blockquote> Defines a long quotation

<caption> Defines a table caption

<cite> Defines a citation

<code> Defines computer code text

<em> Defines emphasized text

<fieldset> Defines a border around elements in a form

<h1> This is heading 1

<h2> This is heading 2

<h3> This is heading 3

<h4> This is heading 4

<h5> This is heading 5

<h6> This is heading 6

<i> Defines italic text

<p> Defines a paragraph

<pre> Defines preformatted text

<q> Defines a short quotation

<samp> Defines sample computer code text

<small> Defines small text

<span> Defines a section in a document

<s> Defines strikethrough text

<strike> Defines strikethrough text

<strong> Defines strong text

<sub> Defines subscripted text

<sup> Defines superscripted text

<u> Defines underlined text

Dr. Dobb's encourages readers to engage in spirited, healthy debate, including taking us to task. However, Dr. Dobb's moderates all comments posted to our site, and reserves the right to modify or remove any content that it determines to be derogatory, offensive, inflammatory, vulgar, irrelevant/off-topic, racist or obvious marketing or spam. Dr. Dobb's further reserves the right to disable the profile of any commenter participating in said activities.

 
Disqus Tips To upload an avatar photo, first complete your Disqus profile. | View the list of supported HTML tags you can use to style comments. | Please read our commenting policy.
 

Video