TICS Coding Standard Viewer 
TIOBE Software Quality Framework
Print-friendly version
©TIOBE Software www.tiobe.com
 
TIOBE - Java Coding Standard
Search

Rule:  Comments104Checked automatically with code checker

Synopsis:Each class should be preceded by JavaDoc comments.
Language:Java
Severity Level:6
Category:Comments


Description:

For example:

import java.sql.ResultSet;
import java.sql.SQLException;

/**
 * Does X and Y and provides an abstraction for Z.
 */

public class Foo {
    ...
}