Ho un collega che insiste sul fatto che il suo codice non ha bisogno di commenti, è "auto-documentazione".
Ho rivisto il suo codice e, sebbene sia più chiaro del codice che ho visto produrre da altri, non sono ancora d'accordo sul fatto che il codice autocompattante sia completo e utile come pure il commento e il documento documentato.
Aiutami a capire il suo punto di vista.
- Cos'è il codice auto-documentante
- Può davvero sostituire il codice ben commentato e documentato
- Ci sono situazioni in cui è meglio di un codice ben documentato e commentato
- Ci sono esempi in cui il codice non può essere auto-documentato senza commenti
Forse sono solo i miei limiti, ma non vedo come possa essere una buona pratica.
Questo non vuole essere un argomento - per favore non evidenziare i motivi per cui un codice ben commentato e documentato ha la massima priorità - ci sono molte risorse che lo dimostrano, ma non sono convincenti per il mio collega. Credo di aver bisogno di capire meglio la sua prospettiva per convincerlo altrimenti. Inizia una nuova domanda se è necessario, ma non discutere qui.
Caspita, risposta rapida! Si prega di leggere tutte le risposte esistenti e fornire commenti alle risposte piuttosto che aggiungere nuove risposte, a meno che la risposta non sia sostanzialmente diversa da ogni altra risposta qui.
Inoltre, quelli di voi che stanno discutendo contro il codice auto-documentante, questo è principalmente per aiutarmi a capire la prospettiva (cioè, gli aspetti positivi) degli evangelisti del codice auto-documentante. Mi aspetto che gli altri ti sottovalutino se non rimani sull'argomento.
i++; // increment i
- ma senza alcuna spiegazione sul perché i
dovrebbe essere incrementato a quel punto della funzione.