Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Javadoc warn on no comment

Tags:

java

javadoc

Is there a way (preferably via an argument, taglet, doclet or similar) to get Javadoc to generate a warning if there is no javadoc comment provided for a method or class? I've had a scout around at the options and Googled but can't see anything that stands out as being relevant. I'm currently working on a project where everything needs to have some form of Javadoc comment and this would be really useful for that purpose.

EDIT: I know such things can be enforced via code quality tools such as checkstyle, I was just wondering if there was a way to configure Javadoc to warn about different things such as this.

like image 850
Michael Berry Avatar asked Dec 29 '22 00:12

Michael Berry


1 Answers

You might try checkstyle to enforce such conventions.

like image 107
Thomas Avatar answered Jan 11 '23 09:01

Thomas