Jtest logo




Contents  Previous  Next  Index

JAVADOC.MVJDT


Javadoc comments for classes and interfaces should have '@version' Javadoc tag

Description

This rule flags any class or interface Javadoc comment that does not have an @version Javadoc tag.

Each class and interface's Javadoc comment should have an @version Javadoc tag.

Example

 /**
   * @author:
   * @see:
   */
    // violation, Class's Javadoc does not have 
 //"@version" tag.
 package JAVADOC;
 public class MVJDT {
     // some declaration.
 }

Repair

Provide an "@version" tag in the Javadoc comment.


Contents  Previous  Next  Index

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