jeroenvanrensen's avatar

Laravel public functions - Why are there @ symbols in comments before a function?

Hi everyone,

I'm new to Laravel, and I saw this video from Laracasts where I learned about policies.

I saw this bit of code:

/**
* Some comment
*
* @param \App\User $user
* @param \App\Conversation $conversation
* @return mixed
*/
public function update(User $user, Conversation $conversation)
{
    //
}

And I'm curious: do the words after the @-symbols (param, return and a few others I saw) a use case? Or are they just for more readable code?

And do they have a specific name? I searched on Google but couldn't found one.

Thank you! Jeroen

0 likes
3 replies
alexreynolds's avatar

I feel strongly about it and love finding out more about it. If you could, as you learn more, would you mind adding more information to your blog

Please or to participate in this conversation.