Consider adding a doc comment for turnRight
45 System.out.println("Turning left " + angle + " degrees");
46 }
47
48 private void turnRight(int angle) {49 System.out.println("Turning right " + angle + " degrees");50 }51}
Consider adding a doc comment for turnLeft
41 System.out.println("Moving backward " + distance + " units");
42 }
43
44 private void turnLeft(int angle) {45 System.out.println("Turning left " + angle + " degrees");46 }47
48 private void turnRight(int angle) {
49 System.out.println("Turning right " + angle + " degrees");Consider adding a doc comment for moveBackward
37 System.out.println("Moving forward " + distance + " units");
38 }
39
40 private void moveBackward(int distance) {41 System.out.println("Moving backward " + distance + " units");42 }43
44 private void turnLeft(int angle) {
45 System.out.println("Turning left " + angle + " degrees");Consider adding a doc comment for moveForward
33 }
34 }
35
36 private void moveForward(int distance) {37 System.out.println("Moving forward " + distance + " units");38 }39
40 private void moveBackward(int distance) {
41 System.out.println("Moving backward " + distance + " units");Consider adding a doc comment for executeInstructions
14}
15
16class Robot {
17 public void executeInstructions(List<String> instructions) {18 for (String instruction : instructions) {19 String[] parts = instruction.split(" ");20 if (parts[0].equals("move")) {21 if (parts[1].equals("forward")) {22 moveForward(Integer.parseInt(parts[2]));23 } else if (parts[1].equals("backward")) {24 moveBackward(Integer.parseInt(parts[2]));25 }26 } else if (parts[0].equals("turn")) {27 if (parts[1].equals("left")) {28 turnLeft(Integer.parseInt(parts[2]));29 } else if (parts[1].equals("right")) {30 turnRight(Integer.parseInt(parts[2]));31 }32 }33 }34 }35
36 private void moveForward(int distance) {
37 System.out.println("Moving forward " + distance + " units");Consider adding a doc comment for main
3import java.util.List;
4
5public class Robotics {
6 public static void main(String[] args) { 7 List<String> instructions = new ArrayList<>(); 8 instructions.add("move forward 10"); 9 instructions.add("turn left 90");10 instructions.add("move backward 5");11 Robot robot = new Robot();12 robot.executeInstructions(instructions);13 }14}
15
16class Robot {
Description
This method does not have any documentation.
Consider adding a documentation comment to explain its use.
While it may seem like the usage of a method is perfectly obvious, any consumers of your API may not be able to pick up on certain details.
Bad Practice
This method appears to return an address string based on its name and the return type, but it is hard to say anything further about it. We neither know if the address will be formatted in a special way nor are we given any useful information regarding the returned value.
String getAddress() {
// ...
}
Recommended
Provide a detailed description of what the method does.
/**
* Returns the address in 3 line format,
* with street address on line 1, area/city on line 2
* and state and country as well as postal code on line 3.
*/
String getAddress() {
// ...
}