web-dev-qa-db-ja.com

再構成されたテキストの文字列にコメントを付ける方法は？

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

htmlrestructuredtext
43
prosseek

参照から ：

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

.. This is a comment
..
   _so: is this!
..
   [and] this!
..
   this:: too!
..
   |even| this:: !
69
jball

コメントの場合は、2つのピリオドを追加します..の後に改行が続き、コメントがインデントされます。

例：

..
  comment goes here
8
Miguel Mota

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

.. only:: comment
    This is a comment

文書化されたとおり（ http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html ）： "Undefined tags is false "、たとえばcomment。

あるいは、拡張機能を todo の形式で記述して、次のような構文を許可することもできます

.. comment::
    This is a comment

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

2
Dr. V

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

上記の答えを使用して、RSTドキュメントの行を単純にマークしようとしましたが、DO [〜＃〜] not [〜＃〜]これを実行してください：

    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.

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

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

1
chrisinmtown