2.8 KiB
Comenta Tu Código
Instrucciones
El código limpio y bien documentado es esencial para mantener y compartir tus proyectos. En esta tarea, practicarás uno de los hábitos más importantes de los desarrolladores profesionales: escribir comentarios claros y útiles que expliquen el propósito y la funcionalidad de tu código.
Revisa tu archivo app.js actual en tu carpeta del juego y encuentra formas de comentarlo y ordenarlo. Es muy fácil que el código se descontrole, y ahora es un buen momento para agregar comentarios que aseguren que tienes un código legible para que puedas usarlo después.
Tu tarea incluye:
- Agregar comentarios que expliquen qué hace cada sección importante del código
- Documentar funciones con descripciones claras de su propósito y parámetros
- Organizar el código en bloques lógicos con encabezados de sección
- Eliminar cualquier código no utilizado o redundante
- Usar convenciones consistentes de nombres para variables y funciones
Rúbrica
| Criterios | Ejemplar | Adecuado | Necesita Mejoras |
|---|---|---|---|
| Documentación del Código | El código en app.js está completamente comentado con explicaciones claras y útiles para todas las secciones principales y funciones |
El código en app.js está adecuadamente comentado con explicaciones básicas para la mayoría de las secciones |
El código en app.js tiene comentarios mínimos y carece de explicaciones claras |
| Organización del Código | El código está organizado en bloques lógicos con encabezados de sección claros y estructura consistente | El código tiene algo de organización con agrupación básica de funcionalidades relacionadas | El código está algo desorganizado y es difícil de seguir |
| Calidad del Código | Todas las variables y funciones usan nombres descriptivos, no hay código no utilizado, sigue convenciones consistentes | La mayoría del código sigue buenas prácticas de nomenclatura con código no utilizado mínimo | Los nombres de variables no son claros, contiene código no utilizado, estilo inconsistente |
Descargo de responsabilidad: Este documento ha sido traducido utilizando el servicio de traducción automática Co-op Translator. Aunque nos esforzamos por la precisión, tenga en cuenta que las traducciones automáticas pueden contener errores o inexactitudes. El documento original en su idioma nativo debe considerarse la fuente autorizada. Para información crítica, se recomienda una traducción profesional realizada por humanos. No nos hacemos responsables de malentendidos o interpretaciones erróneas derivadas del uso de esta traducción.