2011-01-24 10 views

答えて

0

チェック:http://docutils.sourceforge.net/docs/user/rst/quickref.html#comments

明示的なマークアップスタートで始まりますが、上記の構造のいずれかの構文を使用していない任意のテキストは、コメントです。

+6

この回答は例によってより良いでしょう。 – bariumbitmap

+16

**これはひどい答えです。** reStructuredTextコメントの条件は、問題をあまりにも複雑にします。控えめな "RTFM"の後に1行の引用符を付けると、ここで十分ではありません。有効なコメントを構成するものとしないものは、そのコメントの内容とそのコメントを指定するために使用される構文に依存します。それは自明ではなく、明らかではなく、悲劇的に脆弱です。 –

44

From the reference

任意のインデントされたテキストが 明示的なマークアップ開始に従うことができるとコメント要素として を処理されます。

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

この有益な回答の補足として、最初の形式(つまり、これはコメントです。)は実際には使用しないでください。基本的には有害であるとみなされます。どうして?条件付きだから。このように定義された最初の行が、既存の明示的なマークアップ構文(引用、指示、脚注、置換など)の構文と一致するコメントは、コメントではなく静かにその構文として再解釈されます** **は恐ろしいです。これを避けるために、上記の例の残りの部分と同様に、_all_コメントに無条件に接頭辞 '' ''を付ける。 –

+0

Cecil Curryが言っていることを考えれば、@jballが理想的な形を最初に見せて、reSTに汚れたコメントを入れるだけでよいのではないでしょうか。また、私はすでに私がコメントにしたいものを置くことができると仮定しているので、他の例の余分なシンボルは、それ以外の単純な答えを複雑にするだけです。彼らは? – JFlo

関連する問題