Capítulo 95. Escribir comentarios de documentación de una sola frase
Este trabajo se ha traducido utilizando IA. Agradecemos tus opiniones y comentarios: translation-feedback@oreilly.com
Peter Hilton
Una falacia común es suponer que los autores de código incomprensible serán capaces de algún modo de expresarse lúcida y claramente en los comentarios.
Kevlin Henney
Probablemente estás escribiendo demasiados comentarios en tu código, o ninguno. Demasiados generalmente significa demasiados para mantener, que corren el riesgo de convertirse en comentarios peligrosamente imprecisos que es mejor que borres. Demasiados también suele significar que están mal escritos y sin mejorar, porque es difícil escribir "lúcida y claramente". Ninguno significa confiar en una nomenclatura, una estructura de código y unas pruebas perfectas, lo cual es aún más difícil de lo que parece.
Todos hemos visto mucho código cuyos autores no escribieron ningún comentario, ya fuera para ahorrar tiempo, porque no querían hacerlo o porque pensaban que su código se autodocumentaba. A veces el código está realmente así de bien escrito: las primeras mil líneas de un nuevo proyecto, el proyecto de hobby escrito en código artesanal hecho a mano, y quizás el proyecto maduro de biblioteca bien mantenida cuyo estrecho enfoque mantiene la base de código pequeña.
Las grandes aplicaciones son diferentes, especialmente las ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access