W którym miejscu pisać komentarze? Przy funkcji czy w klasie?

0

Chcę stworzyć klasę1 której metoda na podstawie parametrów (string1, string2, string3) utworzy obiekt klasy2 i doda go do tablicy. Gdzie powinny się znajdować komentarze opisujące te stringi? Jako

@param

przy funkcji czy w klasie przy każdej zmiennej w ten sposób:

/**
*
* opis

* @var string
*/
public $zmienna1;
0

ja opisuje metody + większe bloki kodu. Zmienna powinna sama siebie opisywać.

0

Przy polach osobiście wrzucam tylko typ zmiennej, żeby IDE ładnie podpowiadało. Jakiś opisy co z tym się dzieje itp. przed metodą.
Polecam również przeczytać ogólne zalecenia php-fig na temat PHPDoc: https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md Co prawda jest jeszcze w fazie draft ale jakiś większych zmian nie powinni wprowadzać.

0

Nie pisać komentarzy.

PS: Jedyne jakie ja stosuje to albo

/**
 * @var boolean
 */
private $pole;

albo

/**
 * @test
 */

1 użytkowników online, w tym zalogowanych: 0, gości: 1