Undocumented declaration found JAVA-D1003
Documentation
Minor
5 months ago
—
6 months old
Consider adding a doc comment for MimeType
4import java.util.HashMap;
5import java.util.Map;
6
7public enum MimeType 8{ 9 PNG("image/png"),10 JPEG("image/jpeg"),11 PDF("application/pdf"),12 SVG("image/svg+xml");13 14 private static final Map<String,MimeType> lookup 15 = new HashMap<String,MimeType>();16 17 static {18 for(MimeType m : EnumSet.allOf(MimeType.class))19 lookup.put(m.getType(), m);20 } 21 22 private String type;23 24 private MimeType(String type) {25 this.type = type;26 }2728 public String getType() { return type; }2930 public static MimeType get(String type) {31 32 return lookup.get(type); 33 }34}
Description
This declaration is not documented.
Consider adding a documentation comment to explain its functionality.
While it may seem like the functionality of this declaration is perfectly obvious, any consumers of your API or future maintainers may not be able to pick up on certain details.
Bad Practice
In the example below, the meaning of AUIHighlight may not be entirely clear, and questions such as what AUI means may pop up.
public enum AUIHighlight {
LIGHT_BLUE(0x00ADD8E6),
DARK_BLUE(0x0000008B),
// ...
private int value;
AUIHighlight(int val) {
value = val;
}
}
Recommended
Make sure to document any non-obvious details about any code element.
/**
* UI highlight color values for the action bar of the application.
*/
public enum AUIHighlight {
// ...
}