Poorly written comment

Bad grammar or poor phrasing make the code more confusing and harder to read. Comments should be brief and consise

/*
 * Run on sentence and is unnecesarily verbose:
 *
 * When you call doThing1() it runs the doThing algorithm
 * which consisihs of the foloowung forst you apply
 * the first step second you apply the seoncdiosj step
 * third you doe this thing but if the other thing happens
 * and finally you eat a chicken sandwhich
 */
public void doThing1() {
...
}



bj 2019-09-22