Jtest logo




Contents  Previous  Next  Index

JAVADOC.MJDC


Missing Javadoc comments

Description

This rule flags any class, method, or field that does not have a Javadoc comment block.

Every class, interface, method, and field should have a Javadoc comment block.

Example

 package JAVADOC; 
 	 
 public class MJDC {   // violation, no Javadoc comments for this
class. 
     /** @param:  size  
       */
     public MJDC (int size) {}
 }

Repair

Provide Javadoc comments for each "class", "interface", method, and field.


Contents  Previous  Next  Index

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