Parcourir la source

robot-name: added hints about no starter implementation

Added new hints.md file copied from exercises/flatten-array/.meta/hints.md
and regenerated the README.md file using configlet. Fixes #1090
Christopher Thornton il y a 8 ans
Parent
révision
6e249b160b
2 fichiers modifiés avec 120 ajouts et 0 suppressions
  1. 58
    0
      exercises/robot-name/.meta/hints.md
  2. 62
    0
      exercises/robot-name/README.md

+ 58
- 0
exercises/robot-name/.meta/hints.md Voir le fichier

@@ -0,0 +1,58 @@
1
+Since this exercise has difficulty 5 it doesn't come with any starter implementation.
2
+This is so that you get to practice creating classes and methods which is an important part of programming in Java.
3
+It does mean that when you first try to run the tests, they won't compile.
4
+They will give you an error similar to:
5
+```
6
+ path-to-exercism-dir\exercism\java\name-of-exercise\src\test\java\ExerciseClassNameTest.java:14: error: cannot find symbol
7
+        ExerciseClassName exerciseClassName = new ExerciseClassName();
8
+        ^
9
+ symbol:   class ExerciseClassName
10
+ location: class ExerciseClassNameTest
11
+```
12
+This error occurs because the test refers to a class that hasn't been created yet (`ExerciseClassName`).
13
+To resolve the error you need to add a file matching the class name in the error to the `src/main/java` directory.
14
+For example, for the error above you would add a file called `ExerciseClassName.java`.
15
+
16
+When you try to run the tests again you will get slightly different errors.
17
+You might get an error similar to:
18
+```
19
+  constructor ExerciseClassName in class ExerciseClassName cannot be applied to given types;
20
+        ExerciseClassName exerciseClassName = new ExerciseClassName("some argument");
21
+                                              ^
22
+  required: no arguments
23
+  found: String
24
+  reason: actual and formal argument lists differ in length
25
+```
26
+This error means that you need to add a [constructor](https://docs.oracle.com/javase/tutorial/java/javaOO/constructors.html) to your new class.
27
+If you don't add a constructor, Java will add a default one for you.
28
+This default constructor takes no arguments.
29
+So if the tests expect your class to have a constructor which takes arguments, then you need to create this constructor yourself.
30
+In the example above you could add:
31
+```
32
+ExerciseClassName(String input) {
33
+
34
+}
35
+``` 
36
+That should make the error go away, though you might need to add some more code to your constructor to make the test pass!
37
+
38
+You might also get an error similar to:
39
+```
40
+  error: cannot find symbol
41
+        assertEquals(expectedOutput, exerciseClassName.someMethod());
42
+                                                       ^
43
+  symbol:   method someMethod()
44
+  location: variable exerciseClassName of type ExerciseClassName
45
+```
46
+This error means that you need to add a method called `someMethod` to your new class.
47
+In the example above you would add:
48
+```
49
+String someMethod() {
50
+  return "";
51
+}
52
+```
53
+Make sure the return type matches what the test is expecting.
54
+You can find out which return type it should have by looking at the type of object it's being compared to in the tests.
55
+Or you could set your method to return some random type (e.g. `void`), and run the tests again.
56
+The new error should tell you which type it's expecting.
57
+
58
+After having resolved these errors you should be ready to start making the tests pass!

+ 62
- 0
exercises/robot-name/README.md Voir le fichier

@@ -15,6 +15,68 @@ The names must be random: they should not follow a predictable sequence.
15 15
 Random names means a risk of collisions. Your solution must ensure that
16 16
 every existing robot has a unique name.
17 17
 
18
+# Java Tips
19
+
20
+Since this exercise has difficulty 5 it doesn't come with any starter implementation.
21
+This is so that you get to practice creating classes and methods which is an important part of programming in Java.
22
+It does mean that when you first try to run the tests, they won't compile.
23
+They will give you an error similar to:
24
+```
25
+ path-to-exercism-dir\exercism\java\name-of-exercise\src\test\java\ExerciseClassNameTest.java:14: error: cannot find symbol
26
+        ExerciseClassName exerciseClassName = new ExerciseClassName();
27
+        ^
28
+ symbol:   class ExerciseClassName
29
+ location: class ExerciseClassNameTest
30
+```
31
+This error occurs because the test refers to a class that hasn't been created yet (`ExerciseClassName`).
32
+To resolve the error you need to add a file matching the class name in the error to the `src/main/java` directory.
33
+For example, for the error above you would add a file called `ExerciseClassName.java`.
34
+
35
+When you try to run the tests again you will get slightly different errors.
36
+You might get an error similar to:
37
+```
38
+  constructor ExerciseClassName in class ExerciseClassName cannot be applied to given types;
39
+        ExerciseClassName exerciseClassName = new ExerciseClassName("some argument");
40
+                                              ^
41
+  required: no arguments
42
+  found: String
43
+  reason: actual and formal argument lists differ in length
44
+```
45
+This error means that you need to add a [constructor](https://docs.oracle.com/javase/tutorial/java/javaOO/constructors.html) to your new class.
46
+If you don't add a constructor, Java will add a default one for you.
47
+This default constructor takes no arguments.
48
+So if the tests expect your class to have a constructor which takes arguments, then you need to create this constructor yourself.
49
+In the example above you could add:
50
+```
51
+ExerciseClassName(String input) {
52
+
53
+}
54
+``` 
55
+That should make the error go away, though you might need to add some more code to your constructor to make the test pass!
56
+
57
+You might also get an error similar to:
58
+```
59
+  error: cannot find symbol
60
+        assertEquals(expectedOutput, exerciseClassName.someMethod());
61
+                                                       ^
62
+  symbol:   method someMethod()
63
+  location: variable exerciseClassName of type ExerciseClassName
64
+```
65
+This error means that you need to add a method called `someMethod` to your new class.
66
+In the example above you would add:
67
+```
68
+String someMethod() {
69
+  return "";
70
+}
71
+```
72
+Make sure the return type matches what the test is expecting.
73
+You can find out which return type it should have by looking at the type of object it's being compared to in the tests.
74
+Or you could set your method to return some random type (e.g. `void`), and run the tests again.
75
+The new error should tell you which type it's expecting.
76
+
77
+After having resolved these errors you should be ready to start making the tests pass!
78
+
79
+
18 80
 # Running the tests
19 81
 
20 82
 You can run all the tests for an exercise by entering