Comentario de markdown
Markdown es independiente de la plataforma y se puede transportar en prácticamente cualquier aplicación. Como resultado, ha ganado un amplio uso en el desarrollo web, como blogs, documentos, cuadernos, correos electrónicos y etc.
¿Cómo funciona Markdown??
Como se mencionó, Markdown es un lenguaje de marcado. Por lo tanto, trabaja en un archivo que termina en .md o .extensión de markdown. Este archivo contiene elementos de formato como encabezados, bloques de códigos, hendiduras, alineaciones y etc.
El documento de Markdown es procesado por una aplicación conocida como procesador de Markdown o analizador. El analizador luego toma el texto formateado y produce el documento HTML. Luego puede ver el documento HTML en un navegador o cualquier aplicación que lo admita.
La imagen a continuación ilustra cómo funciona este proceso.
(Esta imagen es la guía de markdown de formulario.)
Puede obtener más información sobre cómo funciona Markdown en el recurso a continuación:
https: // www.guía.org/
¿Qué es un comentario de Markdown??
Un comentario de Markdown se refiere a un texto agregado a un archivo de Markdown pero ignorado por la aplicación Renderer. Por lo tanto, un comentario de Markdown no se muestra en la salida generada.
Los comentarios son útiles cuando necesita incluir texto oculto en su documento que solo sea visible para el autor del documento pero que no esté expuesto en el documento resultante.
Cómo insertar comentarios de Markdown
Desafortunadamente, Markdown no proporciona apoyo nativo para los comentarios. Sin embargo, puede usar soluciones importadas para agregar comentarios a su documento de Markdown.
Método 1
La primera sintaxis para agregar un comentario en Markdown es colocar su texto de comentarios dentro de un par de soportes cuadrados, seguido de un colon, un espacio y un signo de libra.
La sintaxis es como se muestra:
[comment_text]: #
El texto dentro de los soportes cuadrados es tratado como un comentario e ignorado por el renderizador de Markdown.
Un ejemplo es como se muestra:
## Ilustración de comentarios de markdown
Este es un párrafo
[Este es un comentario]: #
El comentario anterior no es visible.
En el ejemplo anterior, tenemos una simple sintaxis de Markdown con un encabezado, un párrafo, un comentario y otro párrafo.
Método 2
La sintaxis a continuación también puede insertar comentarios en un documento de Markdown.
[//]: # (el texto de comentarios va aquí)
Esto se considera el formato más compatible con la plataforma para agregar comentarios.
Otra variación de esta sintaxis es:
[//]: # "El texto de comentarios va aquí"
Método 3
En algunos motores de Markdown, puede omitir las dos barras de avance y usar la sintaxis a continuación:
[]: # (texto de comentarios)
o
[]: # "texto de comentarios"
o
[]: # 'Texto de comentarios'
Método 4
También puede incluir comentarios HTML en Markdown como se ilustra en la sintaxis a continuación:
Las aplicaciones populares de Markdown admiten el método anterior.
Método 5
GitHub también le permite usar la sintaxis a continuación para denotar comentarios:
:: comentario
texto de comentarios
:/comentario
Aunque, la sintaxis anterior es que no se adopta y usa convencionalmente.
Clausura
En este tutorial, descubrió cinco métodos efectivos para agregar comentarios a su comentario de Markdown.