standard dokumentacji PHPDoc

• @return – służy do opisania, co funkcja zwraca
• void – informuje, że funkcja nie zwraca żadnej wartości (czyli w kodzie nie ma return z wartością, a jedynie ewentualnie samo return;)

 

Dlaczego to jest ważne?

Komentarze PHPDoc pomagają:

• zrozumieć kod – łatwiej zorientować się, jak działa funkcja i czego można się po niej spodziewać
• dla narzędzi IDE – edytory kodu (np. PhpStorm, VSCode) wykorzystują te informacje, aby podpowiadać programiście (autouzupełnianie, analizy błędów itp.)
• w dokumentacji – gdy kod jest generowany jako dokumentacja (np. za pomocą narzędzia phpDocumentor)

wygląd poprawnego komentarza:

/**
 * Funkcja wykonuje jakąś akcję, ale niczego nie zwraca.
 *
 * @return void
 */