Clean Code – Chapter 4: Comments

“Don’t comment bad code—rewrite it.”——Brian W.Kernighan and P.J.Plaugher

The proper use of comments is to compensate for our failure to express ourself in code.

Truth can only be found in one place: the code.

• Comments Do Not Make Up for Bad Code

  Rather than spend your time writting the comments that explains the mess you have made, spend it cleaning that mess.

• Explain Yourself in Code

  In many cases it's simply a matter of creating a function that says the same thing as the comment you want to write.

• Good Comments

  The only truly good comment is the comment you found a way not to write.

  • Legal Comments

    // copyright (c) ...

  • Informative Comments

    // format matched kk:mm:ss EEE, MMM dd, yyyy
    Pattern timeMatcher = Pattern.compile(
        "\\d*:\\d*:\\d* \\w*, \\w* \\d*, \\d*");

  • Explanation of Intent

  • Clarification

    Translate the meaning of some obscure argument or return value into something that's readable.

  • Warning of Consequences

  • TODO Comments

  • Amplification

    Amplify the importance of something that may otherwise seem inconsequential.

  • Javadocs in Public APIs

• Bad Comments

  • Mumbling

    Any comment that forces you to look in another module for the meaning of that comment has failed to communicate to you and is not worth the bits it consumes.

  • Redundant Comments

    Comments that take longer to read than the code itself.

  • Misleading Comments

  • Mandated Comments

    It is just plain silly to have a rule that says that every function must have a javadoc, or every varible must have a comment.

  • Journal Comments

    Remove the comment log of editing and have source code control system to do it.

  • Noise Comments

    • Restate the obvious
    • vent

  • Don't Use a Comment When You Can Use a Function or a Variable

  • Position Markers

    Avoid overuse of banners.

  • Closing Brace Comments

    If you find yourself wanting to mark your closing braces, try to shorten your functions instead.

  • Attributions and Bylines

    Use source code control system instead.

  • Commented-Out Code

    Just delete it and again use source code control system instead.

  • HTML Comments

    It should be the responsibility of the tools. (like Javadoc)

  • Nonlocal Information

    Make sure a comment describes the code it appears near.

  • Too Much Information

    Don't put interesting historical discussions or irrelevant descriptions of details into your comments.

  • Inobvious Connection

    It is a pity when a comment needs its own explanation.

  • Function Headers

    A well-chosen name for a small function that does one thing is usually better than a comment header.

  • Javadocs in Nonpublic Code

e.g.

Bad code:

// Clean Code
// Listing 4-7
// GeneratePrimes.java

/**
* This class Generates prime numbers up to a user specified
* maximum. The algorithm used is the Sieve of Eratosthenes.
* <p>
* Eratosthenes of Cyrene, b. c. 276 BC, Cyrene, Libya --
* d. c. 194, Alexandria. The first man to calculate the
* circumference of the Earth. Also known for working on
* calendars with leap years and ran the library at Alexandria.
* <p>
* The algorithm is quite simple. Given an array of integers
* starting at 2. Cross out all multiples of 2. Find the next
* uncrossed integer, and cross out all of its multiples.
* Repeat untilyou have passed the square root of the maximum
* value.
*
* @author Alphonse
* @version 13 Feb 2002 atp
*/
import java.util.*;

public class GeneratePrimes {
    /**
    * @param maxValue is the generation limit.
    */
    public static int[] generatePrimes(int maxValue) {
        if (maxValue >= 2) { // the only valid case
            // declarations
            int s = maxValue + 1; // size of array
            boolean[] f = new boolean[s];
            int i;

            // initialize array to true.
            for (i = 0; i < s; i++)
                f[i] = true;

            // get rid of known non-primes
            f[0] = f[1] = false;

            // sieve
            int j;
            for (i = 2; i < Math.sqrt(s) + 1; i++) {
                if (f[i]) { // if i is uncrossed, cross its multiples.
                    for (j = 2 * i; j < s; j += i)
                        f[j] = false; // multiple is not prime
                }
            }

            // how many primes are there?
            int count = 0;
            for (i = 0; i < s; i++) {
                if (f[i])
                    count++; // bump count.
            }
            int[] primes = new int[count];

            // move the primes into the result
            for (i = 0, j = 0; i < s; i++) {
                if (f[i]) // if prime
                    primes[j++] = i;
            }
            return primes; // return the primes
        }
        else // maxValue < 2
            return new int[0]; // return null array if bad input.
    }
}

Good code:

// Clean Code
// Listing 4-8
// PrimeGenerator.java (refactored)

/**
* This class Generates prime numbers up to a user specified
* maximum. The algorithm used is the Sieve of Eratosthenes.
* Given an array of integers starting at 2:
* Find the first uncrossed integer, and cross out all its
* multiples. Repeat until there are no more multiples
* in the array.
*/
public class PrimeGenerator
{
    private static boolean[] crossedOut;
    private static int[] result;

    public static int[] generatePrimes(int maxValue)
    {
        if (maxValue < 2)
            return new int[0];
        else
        {
            uncrossIntegersUpTo(maxValue);
            crossOutMultiples();
            putUncrossedIntegersIntoResult();
            return result;
        }
    }

    private static void uncrossIntegersUpTo(int maxValue)
    {
        crossedOut = new boolean[maxValue + 1];
        for (int i = 2; i < crossedOut.length; i++)
            crossedOut[i] = false;
    }

    private static void crossOutMultiples()
    {
        int limit = determineIterationLimit();
        for (int i = 2; i <= limit; i++)
            if (notCrossed(i))
                crossOutMultiplesOf(i);
    }

    private static int determineIterationLimit()
    {
        // Every multiple in the array has a prime factor that
        // is less than or equal to the root of the array size,
        // so we don't have to cross out multiples of numbers
        // larger than that root.
        double iterationLimit = Math.sqrt(crossedOut.length);
        return (int) iterationLimit;
    }

    private static void crossOutMultiplesOf(int i)
    {
        for (int multiple = 2*i;
                multiple < crossedOut.length;
                multiple += i)
            crossedOut[multiple] = true;
    }

    private static boolean notCrossed(int i)
    {
        return crossedOut[i] == false;
    }

    private static void putUncrossedIntegersIntoResult()
    {
        result = new int[numberOfUncrossedIntegers()];
        for (int j = 0, i = 2; i < crossedOut.length; i++)
            if (notCrossed(i))
                result[j++] = i;
    }

    private static int numberOfUncrossedIntegers()
    {
        int count = 0;
        for (int i = 2; i < crossedOut.length; i++)
            if (notCrossed(i))
                count++;
        return count;
    }
}