Cómo agregar comentarios con Markdown

En ocasiones querrías poder insertar un comentario en tus documentos Markdown que no se muestre en el documento final. Podrías querer anotar referencias o simplemente anotaciones para recordar en otro momento. Sin embargo, Markdown no soporta los comentarios, ya que no dispone de una sintaxis para ello.

Afortunadamente existen ciertas alternativas que podrás usar. Una de ellas consiste en un pequeño truco que te permitirá insertar anotaciones invisibles en tus documentos usando la sintaxis oficial. La otra consiste en usar HTML siempre y cuando el editor que uses soporte este lenguaje de marcado.

Agrega comentarios con Markdown

Existe un truco mediante el cual podrías insertar anotaciones mediante la sintaxis de Markdown. Estas anotaciones no serán visibles cuando renderices, imprimas o exportes el documento. No es algo que esté oficialmente soportado, pero funciona. Para ello tendrás que insertar el texto entre corchetes como si de un enlace se tratase [...], seguido de dos puntos :, un espacio y el símbolo sostenido #. Es importante que agregues una línea en blanco tanto antes como después de la anotación.

En este ejemplo insertamos una línea en blanco usando esta sintaxis:

Línea visible.

[Línea invisible.]: # 

Línea visible.

Tal y como ves, hemos agregado el texto de un enlace sin indicar ni en link ni el título. Cuando renderices el documento deberías ver lo siguiente:

Si quieres, también puedes agregar un texto entre parénteses (...) después del símbolo # y que este no sea visible:

Línea visible.

[Línea invisible.]: # (Esto no será visible)

Línea visible.

El resultado del código Markdown anterior debería ser este:

También existe otra alternativa que consiste en insertar el nombre de la referencia entre corchetes [...] como si fuese un enlace, seguido de dos puntos : y los símboloes de menor y mayor <>. Finalmente tendrás que dejar un espacio y redactar la anotación entre paréntesis (...). Es importante que dejes una línea en blanco antes y después de los comentarios:

[comentario A]: <> (Este es el comentario A)
[comentario B]: <> (Este es el comentario B)

También puedes dejarlo más bonito, como si fuese un comentario de PHP o de JavaScript:

[//]: <> (Este es el comentario)

Agrega comentarios con HTML

Si no prefieres insertar las notas con Markdown para así ceñirte a la sintaxis oficial, entonces quizás puedas insertar comentarios mediante HTML si el editor o aplicación Markdown que usas soporta este lenguaje.

Para insetar comentarios usando HTML bastará con que uses la secuencia de caracteres <!-- para inicial el comentario y la secuencia --> para terminarlo. Todo lo que incluyas dentro de estas secuencias será invisible en el documento final.

En el siguiente ejemplo insertamos un comentario mediante la sintaxis de HTML:

Esto será visible. 
<!-- Esto no será visible. -->

Este sería el resultado final al renderizar el documento:

Y con esto ya hemos terminado. Espero que te haya resultado de ayuda.