Conosco la tendenza generale contro i commenti che spiegano come funziona qualcosa, e come sia una buona idea usarli solo per spiegare perché stai facendo quello che stai facendo, ma come usare i commenti come mezzo per dividere il codice?
Supponi di avere uno script che fa un preambolo, cerca in un gruppo di record, stampa i record, quindi chiude tutto:
// Preamble
... preamble code, say about 10-15 lines ...
// Find records
... sql query ...
... put records into array ...
... some other stuff ...
// Print records
... printing records, 20-30 lines a record ...
// Close everything
...
Più di un modo per dividere visivamente il codice, semplificare la ricerca di una determinata sezione. Come se in un mese fosse necessario correggere il codice di stampa, piuttosto che leggere centinaia di righe per cercare di trovare il punto giusto, basta guardare i commenti per vedere dove si trova.
Ciò che effettivamente accade in ogni sezione è abbastanza semplice e facile da dire cosa sta succedendo, questo approccio ai commenti dovrebbe essere considerato buono o cattivo ?
Modifica Sto lavorando principalmente con script PHP, in cui non è possibile inserire il codice in funzioni o è poco pratico farlo. Tuttavia, lo stesso tipo di cosa si applica ai file di grandi dimensioni, con diversi metodi che fanno cose correlate, come getter / setter, aggiornamenti del database, ecc.