1472 votos

Tienda de comentarios en la sintaxis de Markdown

¿Cuál es la sintaxis para guardar un comentario en una rebaja de archivo, por ejemplo. un CVS $Id$ comentario en la parte superior del archivo? No he encontrado nada en las rebajas del proyecto.

1543voto

Magnus Puntos 1641

Creo que todas las anteriormente propuestas de soluciones (aparte de aquellos que requieren implementaciones específicas) resultado en los comentarios incluidos en el HTML de salida, incluso si no se muestran.

Si desea un comentario que es estrictamente para ti mismo (a los lectores de la convierten documento no debe ser capaz de ver que, incluso con "ver código fuente") podría (ab)usar el enlace de etiquetas (para uso con el estilo de referencia links) que están disponibles en el núcleo de la Rebaja de la especificación:

http://daringfireball.net/projects/markdown/syntax#link

Que es:

[comment]: <> (This is a comment, it will not be included)
[comment]: <> (in  the output file unless you use it in)
[comment]: <> (a reference style link.)

O usted podría ir más allá:

[//]: <> (This is also a comment.)

Para mejorar la compatibilidad de las plataformas (y para salvar a una pulsación de tecla) también es posible utilizar # (que es legítimo el destino de hipervínculo) en lugar de <>:

[//]: # (This may be the most platform independent comment)

También puede ser prudente para insertar un espacio antes y después de este tipo de comentarios, debido a que algunas de las Rebajas de los analizadores no como vínculo definiciones rozar el texto normal.

Esto debería funcionar con la mayoría de la Rebaja de los analizadores, ya que es parte de la especificación principal. (incluso si el comportamiento cuando múltiples enlaces están definidos, o cuando el vínculo está definido, pero nunca se utiliza, no es estrictamente especificado).

1048voto

chl Puntos 10205

Puedo utilizar las etiquetas HTML estándar, como

<!---
your comment goes here
and here
-->

Nota el triple de guión. La ventaja es que funciona con pandoc a la hora de generar TeX o HTML de salida. Más información está disponible en la pandoc-discutir en grupo.

55voto

uiroshan Puntos 454

Si usted está usando octopress siguiente, también trabajo.

{% comment %} 
    These commments will not include inside the source.
{% endcomment %}

Así que tu comentario no se incluyen en la fuente compilado. Para que los visitantes no podrán ver cuando intentan ver código fuente de su navegador.

29voto

Stu Puntos 554

Una alternativa es poner comentarios dentro de estilizada etiquetas HTML. De esta manera, usted puede cambiar su visibilidad como sea necesario. Por ejemplo, definir un comentario de la clase en su hoja de estilos CSS.

.comment { display: none; }

A continuación, la siguiente mejorada de las REBAJAS

We do <span class="comment">NOT</span> support comments

siguiente aparece en un NAVEGADOR

We do support comments

11voto

Ryne Everett Puntos 502

Dado que la pregunta no especifica un determinado rebajas aplicación me gustaría mencionar el Plugin de Comentarios para python-markdown, el cual implementa el mismo pandoc estilo de comentario mencionados anteriormente.

Iteramos.com

Iteramos es una comunidad de desarrolladores que busca expandir el conocimiento de la programación mas allá del inglés.
Tenemos una gran cantidad de contenido, y también puedes hacer tus propias preguntas o resolver las de los demás.

Powered by:

X