A public method or constructor that does not have a Javadoc tag for each parameter makes an API more difficult to understand and maintain.

The Javadoc comment for a method or constructor should include a Javadoc tag element that describes each parameter.

The following example shows a good Javadoc comment, which clearly explains the method's parameter.

  • J. Bloch, Effective Java (second edition), Item 44. Addison-Wesley, 2008.
  • Help - Eclipse Platform: Java Compiler Javadoc Preferences.
  • Java SE Documentation: How to Write Doc Comments for the Javadoc Tool, Requirements for Writing Java API Specifications.