File tree 1 file changed +23
-0
lines changed
1 file changed +23
-0
lines changed Original file line number Diff line number Diff line change @@ -43,3 +43,26 @@ atoum provides 3 aliases for the main test class, choose the one you prefer:
43
43
Once done, you will get full featured code-completion:
44
44
45
45
![ atoum-stubs] ( demo.gif )
46
+
47
+ ## Why?
48
+
49
+ > Why are the PHPdoc annotations part of an external repository?
50
+
51
+ Because we just don't want them in the middle of atoum's source code. It's not really useful there and it adds extra
52
+ noise.
53
+
54
+ Moreover, if we use PHPDoc for the userland API we should also add annotations to every method of the internal API. Too
55
+ much work for a small amount of added value.
56
+
57
+ > Why are those annotations only working on atoum aliases?
58
+
59
+ Because we stored annotated code in an external repository, we would have to duplicate some classes to annotate them.
60
+ Doing so would create duplicate classes and some IDEs will emit warnings.
61
+
62
+ We don't want to add extra noise while providing a good code-completion.
63
+
64
+ > Why not annotating every public method?
65
+
66
+ Because they are not all meaningful in a test context. When you write unit tests with atoum, you will likely never call
67
+ internal asserters' methods, even if they are public. They provide support for atoum so it can do its job well. But they
68
+ won't help you in your everyday work.
You can’t perform that action at this time.
0 commit comments