80

HTMLのコメントは<!-- .. -->、再構成されたテキストでこのコメントブロックを作成するにはどうすればよいですか？つまり、再構成されたテキストの一部の行をコメント化するにはどうすればよいですか？

4

5 に答える 5

120

参考から：

任意のインデントされたテキストは、明示的なマークアップの開始に続く場合があり、コメント要素として処理されます。

..
   _This: is a comment!

..
   [and] this!

..
   this:: too!

..
   |even| this:: !

二重点と同じ行にコメントを付けることもできます。

.. Avoid this type of comment

ただし、以下のコメントで@CecilCurryが指摘しているように、コメントが適切なマークアップ構造と一致すると、意図しない結果が生じる可能性があるため、これは悪い習慣と見なされます。

于 2011-01-24T15:41:22.090 に答える
19

コメントの場合は、2つのピリオドを追加..し、その後に改行を追加してから、コメントをインデントします。

例：

..
  comment goes here
于 2019-07-30T08:24:19.550 に答える
6

私はこのスレッドに出くわし、再構成されたテキストにコメントを配置するためのより明確な方法を探しました。個人的には、もちろんワンライナーも好きではありません .. this is a comment。コメントを検索して認識できるようにするために、使用を検討することを提案します

.. only:: comment

    This is a comment

文書化されているように（http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html）：「未定義のタグはfalseです」などcomment。

または、 todoのスタイルで拡張機能を記述して、次のような構文を使用することもできます。

.. comment::
    This is a comment

もちろん、そのような拡張なしでそうすると、ビルダーからエラーメッセージが表示されます。しかし、このような拡張機能を使用すると、 todoと同様に、ドキュメントからコメントのリストを抽出することができます。

于 2020-01-03T14:21:15.943 に答える
5

私が私のようなRST初心者を助けようとしているこの重複した答えを許してください。私の答えはコメントの文脈を示しています。

上記の回答を使用して、RSTドキュメントに行を単純にマークしようとしました。これは行わないでください。

    Lorem ipsum dolor sit amet, consectetur adipiscing elit.
    .. Hi everyone this line will never be seen
    Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Sphinx（または他のRSTフォーマッター）は文句を言いませんが、「こんにちはみんな」が出力に表示されます。代わりに、次のようにコメントの前後に空白行を配置します。

    Lorem ipsum dolor sit amet, consectetur adipiscing elit.

    .. 
        comment Hi everyone this line will never be seen

    Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

ただし、これの欠点は、段落が終了してから再開されるため、間に空白ができることです。

RSTで、一部のテキストを完全に消滅させる可能性のあるC/* */またはHTMLコメント構文に相当するものは見つかりませんでした。<!-- -->

于 2019-10-28T18:46:26.443 に答える
-10

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

明示的なマークアップ開始で始まるが、上記の構成の構文を使用しないテキストは、コメントです。

于 2011-01-24T15:41:12.550 に答える