Bladeren bron

Merge pull request #1240 from c-thornton/series

series: added hints about no starter implementation
Sam Warner 8 jaren geleden
bovenliggende
commit
beb31ec3a6
Geen account gekoppeld aan de committers e-mail
2 gewijzigde bestanden met toevoegingen van 120 en 0 verwijderingen
  1. 58
    0
      exercises/series/.meta/hints.md
  2. 62
    0
      exercises/series/README.md

+ 58
- 0
exercises/series/.meta/hints.md Bestand weergeven

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/series/README.md Bestand weergeven

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