如何在重组文本中注释字符串?

时间:2011-01-24 15:36:59

标签: html restructuredtext

HTML的评论是<!-- .. -->,如何使用重组文本制作此评论栏?换句话说,如何在重组文本中注释掉一些行?

5 个答案:

答案 0 :(得分:53)

From the reference

  

任意缩进文字可以跟随   显式标记开始并将是   作为评论元素处理。

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

答案 1 :(得分:4)

我遇到了这个线程,正在寻找一种更定义的方式来将评论放置在重组文本中。就我个人而言,我当然也不喜欢单线.. this is a comment。为了使评论可搜索和可识别,我建议考虑使用

.. only:: comment
    This is a comment

据记录(http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html):“ 未定义的标签为假”,例如comment

或者,可以编写todo样式的扩展名,允许使用语法,例如

.. comment::
    This is a comment

如果没有这样的扩展,这样做当然会产生来自构建器的错误消息。但是有了这样的扩展名,就像 todo 一样,就有可能从文档中提取评论列表。

答案 2 :(得分:3)

要发表评论,请添加两个句点..,后跟换行符,然后将您的评论缩进。

示例:

..
  comment goes here

答案 3 :(得分:0)

请原谅这个重复的答案,因为我想帮助像我这样的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 <!-- -->注释语法的等效项,这些语法可以使某些文本完全消失。

答案 4 :(得分:-8)

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

  

任何以显式标记开头但不使用上述任何结构语法的文本都是注释。