Codice PHP:
/**
* Formatta un testo.
*/
class Formatter {
/**
* Formatta un testo.
*
* @param string $text Il testo da formattare.
* @return string Il testo formattato.
*/
function format(string $text): string {
// ...
}
}
Come vedete la descrizione "Formatta un testo" viene ripetuta sia nel docblock della classe, che nel docblock del metodo.
Per evitare queste rindondanze, in genere che stile usate per i vostri docblock?
Mettere la descrizione solo nel docblock della classe?
Mettere la descrizione solo nel docblock del metodo?
Usare una descrizione un po' diversa (per il metodo), ad esempio "Esegue la formattazione"?