Added docblocks #1
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1 +/- ##
=======================================
Coverage 100% 100%
Complexity 34 34
=======================================
Files 1 1
Lines 70 70
=======================================
Hits 70 70
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Hi Daniel,
Thanks a lot for the PR. It certainly makes many things very clear now from the docblock.
Because we use PHP 7.2, I tried to use as little as possible doc blocks, and I personally would prefer not to use @param and @return where they are enforced with parameter and return type hints.
The escape methods for HTML, URL, and helper for the attributes really could use your comments, and I'm sure they are immensely helpful. Would you mind if we not use doc block @param and @return for methods where it is enforced in the type hint and the parameter name is clear enough what the parameter values should be?
Thanks again for the PR. I started this project just to separate something I wanted for a small project, and in a field with several template engines, some even with their own language and many features sprinkled everywhere, I am glad this deserved got your attention and valuable time.
| * Get view data by key name. | ||
| * | ||
| * @param string $key The key | ||
| * @return mixed|null The value |
|
I try to write code as consistent as possible and DocBlocks are part of it for me. Although data types can be strictly defined since PHP 7.2, parameters and return values are often in need of explanation. It's nice that we finally have strict types, but we humans have to be able to understand the code too. :-) |
|
Hi @odan - I'm so sorry it took me a long time to go with this PR. I believe the .gitignore file should only relate to the project files and IDE-specific ignore rules should go to the developer's Again I'm sorry for the koala-like maintainership and thanks again for this PR! |
No description provided.