Jtest logo




Contents  Previous  Next  Index

JAVADOC.PARAM


Method should have equal number of '@param' Javadoc tags as parameters

Description

This rule flags any method argument that does not have a corresponding `@param' Javadoc tag.

Example

 package JAVADOC;
 public class PARAM {
     /**  
      */   //violation
     private void setId (String name) {
         _id = name;
     }
     String _id;
 }

Repair

Provide an @param tag for each method that has arguments.


Contents  Previous  Next  Index

ParaSoft logo
(888) 305-0041 info@parasoft.com Copyright © 1996-2001 ParaSoft