"First sentence should end with a period."
Java checkstyle confuses and baffles me.
package pmain;
/**
* Some text here.
*/
public class Main {
}
This is literally all of the code I have. Checkstyle displays a "First sentence should end with a period." at the "/**".
Why does CheckStyle produce this warning?
Could the checkstyle config I'm required to use be broken? Am I doing something wrong? Is "Some text here" not the first sentence? Is "." not a period?
Answer
The first sentence should end with a dot.
/**
*An abstract class that represents an algorithm.
*
* @author zhangtj
*
* @version 1.0
*/
Would pass.