Docblock consigliati per una classe e per i metodi

di il
2 risposte

Docblock consigliati per una classe e per i metodi

Osservate questi esempi.

Docblock solo per la classe:

/**
 * Tool to format a text.
 */
class Formatter {

    function format() {}

}
Docblock solo per il metodo:

class Formatter {

    /**
     * Format a text.
     */
    function format() {}

}
Docblocks per entrambi (leggermente diversificati):

/**
 * Tool to format a text.
 */
class Formatter {

    /**
     * Format a text.
     */
    function format() {}

}
Docblocks identici per entrambi (però creano un po' di rindondanza per i miei gusti):

/**
 * Format a text.
 */
class Formatter {

    /**
     * Format a text.
     */
    function format() {}

}
Voi di solito che modello usate per commentare le vostre classi?

2 Risposte

  • Re: Docblock consigliati per una classe e per i metodi

    Ciao, io uso dockblocks su entrambi anche perchè uso doxygen per generare la documentazione in automatico.
    I blocchi sono evidentemente diversificati, a meno che tu non abbia una classe che fa solo una cosa. In quel caso le descrizioni possono anche essere simili ma il blocco relativo al metodo interno avrà anche eventuali tag @param e @return per descrivere i parametri in ingresso e l'output in uscita.
  • Re: Docblock consigliati per una classe e per i metodi

    Alla fine ho deciso di mettere i docblock solo ai metodi
Devi accedere o registrarti per scrivere nel forum
2 risposte