Tengo un colega que insiste en que su código no necesita comentarios, es "autodocumentado".
He revisado su código, y aunque es más claro que el código que he visto producir a otros, todavía no estoy de acuerdo con que el código autodocumentado sea tan completo y útil como el código comentado y documentado.
Ayúdame a entender su punto de vista.
- ¿Qué es el código autodocumentado?
- ¿Puede realmente reemplazar el código bien comentado y documentado?
- ¿Hay situaciones en las que es mejor que un código bien documentado y comentado?
- ¿Hay ejemplos en los que el código no puede autodocumentarse sin comentarios?
Tal vez son solo mis propias limitaciones, pero no veo cómo puede ser una buena práctica.
Esto no pretende ser un argumento, por favor, no mencione las razones por las cuales el código bien comentado y documentado es de alta prioridad, hay muchos recursos que lo demuestran, pero no son convincentes para mi compañero. Creo que necesito entender más completamente su perspectiva para convencerlo de lo contrario. Comienza una nueva pregunta si es necesario, pero no discutas aquí.
¡Guau, respuesta rápida! Lea todas las respuestas existentes y proporcione comentarios a las respuestas en lugar de agregar nuevas respuestas, a menos que su respuesta sea realmente diferente de cualquier otra respuesta aquí.
Además, aquellos de ustedes que están argumentando en contra del código autodocumentado, esto es principalmente para ayudarme a comprender la perspectiva (es decir, los aspectos positivos) de los evangelistas autocodificadores de código. Espero que otros te denigren si no te mantienes en el tema.
i++; // increment i
, pero sin explicación sobre por qué i
debería incrementarse en ese punto de la función.