2011-01-24 8 views

Respuesta

0

Comprobar: http://docutils.sourceforge.net/docs/user/rst/quickref.html#comments

Cualquier texto que comienza con un inicio marcado explícita pero no utiliza la sintaxis de cualquiera de las construcciones anteriores, es un comentario.

+6

Esta respuesta sería mejor con un ejemplo. – bariumbitmap

+16

** Esta es una respuesta horrible. ** La condicionalidad de los comentarios de ReStructuredText complica demasiado las cosas. Un "RTFM" conciso seguido de una cita de línea única no es suficiente aquí. Lo que constituye y no constituye un comentario válido depende léxicamente del contenido de ese comentario _y_ la sintaxis utilizada para especificar ese comentario. No es trivial, no es obvio y trágicamente frágil. –

44

From the reference:

arbitraria texto sangrado puede seguir el inicio marcado explícito y se procesado como un elemento de comentario.

.. This is a comment 
.. 
    _so: is this! 
.. 
    [and] this! 
.. 
    this:: too! 
.. 
    |even| this:: ! 
+5

Como una adición a esta útil respuesta, el primer formulario (es decir, '" ... Este es un comentario "') no debe usarse nunca en la práctica. Básicamente, considerado dañino. ¿Por qué? Porque condicionalidad. Cualquier comentario definido de esta manera cuya primera línea coincida con la sintaxis de cualquier construcción explícita de marcado (p. Ej., Cita, directiva, nota al pie, sustitución) se reinterpretará silenciosamente como ese constructo en lugar de como un comentario ** que es horrible. ** Para evitar esto, prefijo incondicionalmente _todos los comentarios con una instrucción de línea única "" .. "' como en el resto de los ejemplos anteriores. –

+0

Dado lo que ha dicho Cecil Curry, sería muy bueno si @jball revisara su ejemplo para mostrar primero una forma ideal, así que no necesito leer toda la letra pequeña solo para poner un comentario desagradable en mi reST. Además, ya asumo que puedo poner lo que quiero en un comentario, por lo que todos los símbolos adicionales en los otros ejemplos solo sirven para complicar una respuesta que de otra manera sería simple ... a menos que sean relevantes. ¿Son ellos? – JFlo

Cuestiones relacionadas