Repensar los comentarios del código

 

 

 

Justin Duke pregunta si tratar los comentarios de código como notas a pie de página podría ayudarnos a comprender mejor el código de un archivo. En su maqueta, todos los comentarios están ocultos de forma predeterminada y requieren un clic para revelarse:

¡Qué buena idea! El diseño de Justin me recuerda la forma en que Instapaper trataba las notas a pie de página en línea.

Supongo que la razón por la que me gusta tanto esta idea es que no es necesario leer muchos comentarios constantemente; son una especie de recordatorio de que “Oye, esto necesita mejorarse en el futuro” o “Ay, esto Es raro y lo siento”. Mantener estos comentarios fuera del código también hace que sea mucho más fácil escanear todo el archivo.

 

Me pregunto si podría haber una opción que muestre cada comentario, en caso de que necesite leer todos los comentarios en secuencia en lugar de hacer clic para alternar cada uno.

De todos modos, toda esta charla sobre comentarios me recuerda una charla absolutamente fantástica de Sarah Drasner en JSConf este año donde habló de por qué es tan difícil hacer los comentarios correctamente:






SUSCRÍBETE A NUESTRO BOLETÍN 

No te pierdas de nuestro contenido ni de ninguna de nuestras guías para que puedas avanzar en los juegos que más te gustan.










Al suscribirte, aceptas nuestra política de privacidad y nuestros términos de servicio.






Tal vez te puede interesar:

  1. La innovación no puede mantener la Web rápida
  2. Rendimiento web ultrarrápido
  3. Tabla de contenidos fijos con estados activos de desplazamiento
  4. “cambiar tamaño: ninguno;” en áreas de texto es una mala experiencia de usuario

Repensar los comentarios del código

Repensar los comentarios del código

Justin Duke pregunta si tratar los comentarios de código como notas a pie de página podría ayudarnos a comprender mejor el código de un archivo. En su maqu

programar

es

https://pseint.es/static/images/programar-repensar-los-comentarios-del-codigo-1369-0.jpg

2024-06-13

 

Repensar los comentarios del código
Repensar los comentarios del código

Si crees que alguno de los contenidos (texto, imagenes o multimedia) en esta página infringe tus derechos relativos a propiedad intelectual, marcas registradas o cualquier otro de tus derechos, por favor ponte en contacto con nosotros en el mail [email protected] y retiraremos este contenido inmediatamente

 

 

Update cookies preferences