¿cómo hacer un comentario en javascript?

cómo crear una caja de comentarios en html y javascript

¿Alguna vez has escrito un script o un programa en el pasado sólo para mirarlo seis meses después sin tener 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 ve tu código, también será capaz de entenderlo (con suerte).

A menudo los editores de texto tienen la capacidad de comentar muchas líneas de código con una simple pulsación de tecla o una opción en el menú. Si utilizas un editor de texto especializado en programación, asegúrate de comprobar si tiene una opción para comentar fácilmente muchas líneas de código.

comentario de varias líneas en javascript

Una vez más, las propias funciones dicen lo que está pasando. No hay nada que comentar. Y también la estructura del código es mejor cuando se divide. Está claro lo que hace cada función, lo que toma y lo que devuelve.

En realidad, no podemos evitar totalmente los comentarios “explicativos”. Hay algoritmos complejos. Y hay “ajustes” 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 explicando el código. Definitivamente vale la pena estudiarlo.

las mejores prácticas de los comentarios en javascript

Cuando estás inmerso en una sección de código, es fácil recordar el contexto. Sin embargo, cuando otro desarrollador (o tu yo del futuro) vuelve al código existente, también es fácil olvidar exactamente lo que el código debía hacer en el contexto del programa en su conjunto. Aquí es donde brillan los comentarios del código.

Aunque técnicamente son válidos usando la sintaxis multilínea ( /* */ ), los “comentarios en línea” que contienen mucho texto pueden ser difíciles de leer (como es el tema aquí con los comentarios en línea) y por lo tanto deben ser evitados.

Los comentarios DocString aclaran lo que hace el código que le sigue. Por lo general, incluyen el qué, el por qué y, a veces, el quién, pero nunca el cómo. También sirven para documentar las entradas, salidas, e incluso el nombre del desarrollador, así como muchos otros detalles opcionales, pero específicos. Los comentarios DocString se sitúan directamente encima del bloque de código que se está documentando y siguen un formato similar al de los comentarios multilínea.

La sintaxis comienza con /** , termina con */ , y cada línea dentro del bloque comienza con un asterisco * . Las etiquetas especiales se anotan dentro del bloque y comienzan con el símbolo @, como los parámetros ( @param ). Las DocStrings identifican qué parámetros espera la función y qué devuelve, así como una larga lista de detalles opcionales como quién escribió o modificó el código por última vez, el valor de retorno y el número de versión, por nombrar algunos (https://jsdoc.app/ contiene una larga lista de etiquetas, así como ejemplos).

cómo comentar en el atajo de javascript

Hoy en día lo social se ha convertido en la palabra de moda y todos queremos que nuestras aplicaciones sean el centro de estas increíbles conversaciones sociales. Los comentarios en un post, vídeo, actualización o cualquier característica de tu nueva aplicación es una gran manera de añadir diversión y enriquecer las conversaciones sociales a tu aplicación.

Llamaremos a este sistema de comentarios en tiempo real Flash Comments, que puede ser reutilizado para múltiples posts/características de tu app y puede generar increíbles conversaciones en tiempo real. Nuestra aplicación se verá algo así:

Después de instalar todos los módulos npm necesarios, ahora crearemos un archivo de punto de entrada para nuestra aplicación Node como server.js dentro de la carpeta raíz. Añade el siguiente código básico para que se ejecute un servidor HTTP básico utilizando el puerto 9000.

Tendrás que sustituir el appId, la clave y el secreto por valores propios de tu aplicación. Después de esto, vamos a escribir el código para una nueva API que se utilizará para crear un nuevo comentario. Esta api expondrá la ruta /comment con el método HTTP POST y esperará un objeto para el comentario con las propiedades name, email y comment. Añade el siguiente código a tu archivo server.js antes de la parte app.listen.