Dotting the I's and Crossing the T's

With all the coding out of the way, the temptation is there to just dust off your hands and go find the nearest bar. But, as is often said, the devil is in the details, a lot of finishing touches should be put on an application before it's really ready to deploy.

To begin, a JavaDoc hasn't been written for anything or commented in the code. How much commenting you want to put into your code is a bit of a philosophical topic. Just about everyone agrees that this is bad commenting style:

// Definition of addOneToNumber

public int addOneToNumber (int num) // Takes one argument, number
   // Add one to number and return it
   return (num + 1);
}

I call this “Dick and Jane” commenting (after the “See Dick run, run ...

Get MySQL™ and JSP™ Web Applications: Data-Driven Programming Using Tomcat and MySQL now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.