Visualizzazione dei risultati da 1 a 1 su 1

Discussione: docblock rindondante

  1. #1
    Utente di HTML.it
    Registrato dal
    Dec 2013
    Messaggi
    160

    docblock rindondante

    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"?
    Ultima modifica di astros3; 24-10-2019 a 06:32

Permessi di invio

  • Non puoi inserire discussioni
  • Non puoi inserire repliche
  • Non puoi inserire allegati
  • Non puoi modificare i tuoi messaggi
  •  
Powered by vBulletin® Version 4.2.1
Copyright © 2025 vBulletin Solutions, Inc. All rights reserved.