info/php-the-right-way
1
0
Fork 0
mirror of https://github.com/codeguy/php-the-right-way.git synced 2025-08-30 00:29:55 +02:00
Code Issues Projects Releases Wiki Activity

Fix a couple typos in the PHPDoc section

Browse Source
This commit is contained in:
Evgeny Chernyavskiy
2015-10-03 16:35:36 -04:00
parent 96a96b52cf
commit 9c34497e48
1 changed files with 6 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
_posts/15-02-01-PHPDoc.md
View File

@@ -60,17 +60,14 @@ class DateTimeHelper
{% endhighlight %} {% endhighlight %}
The documentation for the class as a whole has the [@author] tag and a [@link] tag. The [@author] tag is used to The documentation for the class as a whole has the [@author] tag and a [@link] tag. The [@author] tag is used to
document the author of the code and can be repeated for documenting several authors. The [@link] tag is used to link to document the author of the code and can be repeated for documenting several authors. The [@link] tag is used to link to a website indicating a relationship between the website and the code.
a website indicating a relationship between the website and the code.
Inside the class, the first method has an [@param] tag documenting the type, name and description of the parameter Inside the class, the first method has a [@param] tag documenting the type, name and description of the parameter
being passed to the method. Additionally it has the [@return] and [@throws] tags for documenting the return type, and being passed to the method. Additionally it has the [@return] and [@throws] tags for documenting the return type, and any exceptions that could be thrown respectively.
any exceptions that could be throw respectively.
The second and third methods are very similar and have a single [@param] tag as did the first method. The import The second and third methods are very similar and have a single [@param] tag as did the first method. The important
difference between the second and third method is doc block is the inclusion/exclusion of the [@return] tag. difference between the second and third method's doc block is the inclusion/exclusion of the [@return] tag.
`@return void` explicitly informs us that there is no return, historically omitting the `@return void` statement also `@return void` explicitly informs us that there is no return; historically omitting the `@return void` statement also results in the same (no return) action.
results in the same (no return) action.
[tags]: http://www.phpdoc.org/docs/latest/references/phpdoc/tags/index.html [tags]: http://www.phpdoc.org/docs/latest/references/phpdoc/tags/index.html