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

Update 15-02-01-PHPDoc.md

Browse Source
This commit is contained in:
Evgeny Chernyavskiy
2015-10-04 13:09:09 -04:00
parent 9c34497e48
commit cf0394b569
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -66,7 +66,7 @@ Inside the class, the first method has a [@param] tag documenting the type, name
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. 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.
The second and third methods are very similar and have a single [@param] tag as did the first method. The important 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's doc block is the inclusion/exclusion of the [@return] tag. difference between the second and third methods' 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 results in the same (no return) action. `@return void` explicitly informs us that there is no return; historically omitting the `@return void` statement also results in the same (no return) action.