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.
|