Il "commento divertente" è una cattiva pratica o no? [chiuso]

Sono un grande fan dei commenti divertenti .

Devi sempre essere professionale nei tuoi commenti, ma un po 'di umorismo non ucciderà il lettore.

Specialmente se il lettore è un membro della tua squadra.

Quello che non mi piace di più sono gli sviluppatori che si prendono troppo sul serio. Penso che dovremmo divertirci al lavoro, o il lavoro non ne vale la pena.

Se ha un significato, va bene essere divertenti. Spiegare qualcosa in un commento in un modo divertente va bene. Tuttavia, se è solo qualcosa di divertente e non contiene alcun valore reale come commento, è solo fastidioso. Ricorda sempre che il motivo dei commenti è rendere la manutenzione più efficiente. L'umorismo non deve entrare in conflitto con quello, ma potrebbe, se non fatto, in modo appropriato.

Il codice è pensato per la lettura ... molte volte.

Quante barzellette sai che sono divertenti dopo il centesimo racconto?

I commenti divertenti sono fantastici.

• Fornisce un'atmosfera positiva al tuo codice apparentemente noioso.
• Se si ottiene il tempo correttamente. Fa molto meglio la spiegazione di un normale commento noioso. Per "tempistica" qui intendo la pertinenza con il codice sotto il commento.
• Il tuo codice verrà ricordato da molti, perché alle emozioni viene assegnato un posto migliore nella memoria (umana). Questo è un grande trucco se vuoi che più ragazzi lavorino con te su un progetto open source.
• Generalmente utile nelle recensioni. Rende il tuo codice molto più sopportabile. Ovviamente dovresti prima concentrarti a scrivere un buon codice. Sento che quando si è sicuri del codice che scrivono, i commenti divertenti sono solo un effetto collaterale.

Semplicemente non essere divertente come questo ragazzo ;)

Ecco uno che ho scritto alle due del mattino ("DQ" sono le iniziali della mia azienda):

// Twas the night before go-live and all through DQ
// the devs were all crying and yes, this means you.
// Keys had been saved with both hyphens and 'scores
// which left this programmer with finger pad sores.
// The solution I crafted, you'll likely find lacking:
// to OR them together with judicuous hacking.

$hyphenated = str_replace('_','-',$data_type_key);
$underscored = str_replace('-','_',$data_type_key);
// (and then see line 46)

Se dovessi riesaminare il codice sorgente di fronte al cliente, ti verrebbe in imbarazzo?

Nessuna delle risposte attuali sembra tenerne conto. Alcuni clienti non hanno il senso dell'umorismo e prenderanno le battute come un indicatore del fatto che non prendi sul serio il tuo lavoro. Essi dedurranno che sei incurante del tuo lavoro.

I commenti di codice divertenti a volte possono essere poco professionali e inappropriati.

Al di là di ciò che è già stato detto, se lavori in team internazionali, alcuni dei tuoi colleghi d'oltreoceano potrebbero non prendere la battuta, perché uno di alcuni riferimenti culturali locali o alcune parole 'gioca che non è compreso da qualcuno per cui l'inglese è non la lingua madre. La stessa cosa vale per i progetti open source.

Se è efficiente e non fa perdere tempo ai lettori (in lettura / comprensione), allora non vedo un problema con un po 'di umorismo.

Proprio come le barzellette nel mondo reale, se le fai tutto il tempo non è divertente, non è produttivo e non è professionale. Ma c'è un tempo e un posto per tutte le barzellette, e c'è un tempo e un posto nel codice. Proprio come nel mondo reale, è sapere dove, quando e come fare la battuta.

Dipende, per gli incarichi universitari, facevo quasi sempre commenti divertenti, poiché sapevo che non sarebbe mai stato usato e sarebbe stato solo un compito a casa.

Per progetti più seri, li utilizzerei ancora qua e là, ma non così diffusi, in modo che sia noioso o difficile da capire, sfidando lo scopo del commento.

Ricordo di aver fatto un po 'di programmazione web, in cui dovevo evitare le incompatibilità del browser e i bizzarri bizzarri. A volte terminava con commenti pieni di rabbia e odio nei file .js .

La mia regola empirica di base è la seguente: se è abbastanza ovvio ciò che fa la sezione del codice, FUNNY COMMENTS TURN ON ON!

Se il codice è così oscuro e offuscante come diavolo (come " in linea classe "), farò meglio ad usare commenti capirò me stesso tra un paio di giorni ...