Undocumented constructor found JAVA-D1002
Documentation
Minor
a year ago
—
2 years old
Consider adding a doc comment for UserHibernateController
18 private SessionFactory factory = null;
19 private Logger logger = null;
20
21 public UserHibernateController(SessionFactory factory) { 22 this.factory = factory; 23 this.logger = Logger.getLogger(UserHibernateController.class.getName()); 24 } 25
26 private Session getSession() {
27 return factory.openSession();Consider adding a doc comment for FolderHibernateController
14public class FolderHibernateController {
15 private SessionFactory factory = null;
16
17 public FolderHibernateController(SessionFactory factory) { 18 this.factory = factory; 19 } 20
21 private Session getSession() {
22 return factory.openSession();Consider adding a doc comment for FileHibernateController
14public class FileHibernateController {
15 private SessionFactory factory = null;
16
17 public FileHibernateController(SessionFactory factory) { 18 this.factory = factory; 19 } 20
21 private Session getSession() {
22 return factory.openSession();Consider adding a doc comment for CourseHibernateController
14 private SessionFactory factory;
15
16
17 public CourseHibernateController(SessionFactory factory) { 18 this.factory = factory; 19 } 20
21 private Session getSession() {
22 return factory.openSession();Consider adding a doc comment for User
35 this.dateModified = LocalDate.now();
36 }
37
38 public User(String login, String password, String name, String surname, String email) { 39 this.login = login; 40 this.password = password; 41 this.name = name; 42 this.surname = surname; 43 this.email = email; 44 this.dateModified = LocalDate.now(); 45 this.dateCreated = LocalDate.now(); 46 } 47
48 public User(String login, String password, String name, String surname, String email, List<File> myFiles) {
49 this.login = login;
Description
This constructor does not have any documentation.
Consider adding a documentation comment to explain its use.
While it may seem like the usage of a constructor is perfectly obvious, any consumers of your API may not be able to pick up on certain details.
Bad Practice
In the example below, it is difficult to understand what the arguments of this constructor for DataForwarder signify.
class DataForwarder {
public DataForwarder(int nTypes, String... values) {
// ...
}
}
Recommended
Document the constructor and provide useful information about it or its parameters as required.
/**
* Initializes a DataForwarder with a set of types to filter by, along with their names.
*
* @param nTypes - The number of types to filter by.
* @param values - The input type names to filter by.
*/
public DataForwarder(int nTypes, String... values) {
// ...
}
Exceptions
If you feel this constructor does not require documentation, you can add a skipcq comment to this constructor.