Recentemente mi sono reso conto che il mio posto di lavoro non commenta le loro applicazioni MVC ASP.NET. Con 'non documenta', intendo che c'è probabilmente 1 riga di commento per modello / vista / controller. Nessuno scopo del file, data di creazione, ecc. La scusa è che il MVC dovrebbe essere auto-documentante, con controller skinny, codice di visualizzazione auto-documentante, ecc. Questa è una spiegazione eccellente, ma molte cose influenzano questa affermazione:
- Anche le tecnologie Javascript vengono implementate insieme al codice della vista senza documentazione sulla loro integrazione (il codice javascript è anche non documentato)
- Ci sono più database e provider che servono contenuti interni ed esterni (non documentati)
- C'è una normale confusione quotidiana tra i programmatori su cosa sta succedendo esattamente in un particolare modulo. Ci vogliono circa 3-4 minuti del tempo di un collaboratore per chiarire.
Questa pratica di commento è pigra e destinata a causare più problemi di quanti ne valga la pena? O non sono abbastanza bravo a leggere il codice di auto-documentazione? Come una domanda a parte, le applicazioni MVC dovrebbero essere meno rigide nei loro standard di commento poiché la separazione delle preoccupazioni dovrebbe rendere ovvio il codice?