Checkstyle does not detect empty javadoc comment

Question

Could you please help me to configure Checkstyle to warn me if the javadoc comment is empty?

Checkstyle dest not warn me in the following case (javadoc comment is totally missing):

/**
 *
 */
public enum MyType{ EQUALS }

I have checked the documentation here, but I could not see anything related this issue.

Well, have you configured Checkstyle to check for this? Which check are you expecting to trigger? — barfuin
– barfuin, Commented Oct 31, 2017 at 21:24
I have checked the documentation but I could not see anything related to this issue. I have no idea which property I need to set in the config file. — zappee
– zappee, Commented Oct 31, 2017 at 21:32
You are right, I have updated my question. Any idea how to check empty javadoc comment? — zappee
– zappee, Commented Nov 1, 2017 at 0:46

Lolo · Accepted Answer · 2017-11-01 08:08:42Z

0

To do this, you can use the Style Javadoc Checkstyle module in the Javadoc Comments section. From the Checkstyle documentation on Style Javadoc:

Validates Javadoc comments to help ensure they are well formed. The following checks are performed:

Ensures the first sentence ends with proper punctuation (That is a period, question mark, or exclamation mark, by default). Javadoc automatically places the first sentence in the method summary table and index. Without proper punctuation the Javadoc may be malformed. All items eligible for the {@inheritDoc} tag are exempt from this requirement.

Check text for Javadoc statements that do not have any description. This includes both completely empty Javadoc, and Javadoc with only tags such as @param and @return.

Make sure to check the checkEmptyJavadoc checkbox:

answered Nov 1, 2017 at 8:08

Lolo

4,3772 gold badges29 silver badges24 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Checkstyle does not detect empty javadoc comment

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related