Jtest logo




Contents  Previous  Next  Index

JAVADOC.MAJDT


Missing '@author' Javadoc tag in a "class" Javadoc comment

Description

This rule flags any Javadoc comment that does not have an @author tag.

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

Example

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

Repair

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


Contents  Previous  Next  Index

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