Co zapisać w komentarzu phpDocumetnor w tagu @return funkcji wytwórczej?

Question

Witam,

Mam sobie klasę, w której mam funkcję wytwórczą warnAmount(), zwraca ona inną funkcję, która jest anonimowa. Tak wygląda przykładowy kod klasy, którą opisałem:

class Totalizer
{
    /**
     * Pełni rolę wytwórni funkcji anonimowych
     * @return [type] [description]
     */
    static function warnAmount()
    {
        return function($product) {
            if ($product->price > 5) {
                print " drogo: {$product->price}\n";
            } else {
                print " tanio: {$product->price}\n";
            }
        };
    }
}

Tak jak w tytule. Nie wiem co wpisać w tagu @return.

Answer 1

Tu masz dokumentację tagu "@return" phpDocumentator:

https://phpdoc.org/docs/latest/references/phpdoc/tags/return.html

A tutaj masz rodzaje typów:

https://phpdoc.org/docs/latest/references/phpdoc/types.html

Według mnie powinieneś w tagu @return zapisać typ "callback", lecz nie jestem w 100% pewien.

Comments

Przeglądałem dokumentację, ale właśnie nie jestem pewien. Mimo wszystko callback zdaje się być rozsądnym rozwiązaniem :)