Comentario de función Javascript
¿Alguna vez has escrito un script o un programa y seis meses más tarde no tienes ni idea de lo que está pasando en el código? Probablemente olvidaste hacer lo que todos los programadores tienden a olvidar: ¡escribir comentarios!
Cuando escribes código puedes tener alguna lógica compleja que es confusa, esta es una oportunidad perfecta para incluir algunos comentarios en el código que explicarán lo que está pasando. Esto no sólo te ayudará a recordarlo más tarde, sino que si alguien más ve tu código, ¡también será capaz de entenderlo (con suerte)!
A menudo, los editores de texto permiten comentar muchas líneas de código con sólo pulsar una tecla o con una opción del menú. Si utilizas un editor de texto especializado en programación, asegúrate de que tiene una opción para comentar fácilmente muchas líneas de código.
Comentario html
Una vez más, las propias funciones dicen lo que pasa. No hay nada que comentar. Además, la estructura del código es mejor cuando está dividido. Queda claro qué hace cada función, qué toma y qué devuelve.
En realidad, no podemos evitar totalmente los comentarios “explicativos”. Hay algoritmos complejos. Y hay “retoques” inteligentes con fines de optimización. Pero, en general, debemos intentar que el código sea sencillo y autodescriptivo.
Proporcionar una visión general de alto nivel de los componentes, cómo interactúan, cuál es el flujo de control en diversas situaciones… En resumen: la vista de pájaro del código. Hay un lenguaje especial UML para construir diagramas de arquitectura de alto nivel que explican el código. Merece la pena estudiarlo.
Buenas prácticas para los comentarios en Javascript
Comentar el código es una característica esencial de muchos lenguajes de programación. La idea detrás de los comentarios de código es que, si bien tu código será leído por el ordenador, también será leído por los seres humanos, por lo que es importante que sea fácil para la gente entender el código que escribes.
Los comentarios te permiten hacer un seguimiento de tu código mientras estás programando, y te dan la posibilidad de tomar notas que pueden ser útiles más adelante. Además, si trabajas en equipo, escribir comentarios te ayudará a garantizar que tu código sea legible para todos los que tengan que contribuir a tu trabajo.
Los comentarios son una parte esencial de la escritura de código legible y fácil de mantener. Lo cierto es que, aunque hoy entiendas el código que estás escribiendo, no hay garantía de que mañana seas capaz de describir eficazmente lo que hace. Además, si trabajas con otras personas, es muy probable que no entiendan parte del código que escribes.
Como desarrollador, escribir comentarios en tu propio código te permitirá hacer un seguimiento más eficaz de lo que estás haciendo. Mientras escribes tu código, puedes tomar notas que te ayudarán a entenderlo mejor y a averiguar la intención del código que has escrito previamente. Escribir comentarios también será útil para otras personas que puedan ver tu código, ya que el comentario probablemente les ayudará a entender cómo funciona tu código en mayor profundidad.
Tipos de comentarios en Javascript
let altura = 170; // La métrica aceptada es centímetros. No pulgadas.Voy a usar comentarios bastante extensivamente para explicar los ejemplos de código en este curso. Empezarás a verlos en la próxima lección. A veces, terminará escribiendo una nota grande donde un comentario de una sola línea no es suficiente. Y aquí es donde los comentarios multilínea son útiles.Comentarios multilíneaLos comentarios multilínea comienzan con /* y terminan con */Por ejemplo:/*
let email = userSubmittedEmail; // Sanitize the emailLos comentarios son para nosotrosLos comentarios son más como notas para ti mismo y para otros que podrían acabar usando el código.Por ejemplo, a menudo acabas abriendo un trozo de código después de mucho tiempo porque un cliente ha vuelto pidiendo ayuda. Y si no has escrito comentarios en tu código, créeme, a veces te estarás rompiendo la cabeza preguntándote qué demonios está haciendo una línea de código en particular.