HTML 的注释是<!-- .. -->，我怎样才能用重组文本制作这个注释块？换句话说，我怎样才能注释掉重组文本中的一些行？
问问题
36994 次
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
我遇到了这个线程，正在寻找一种更明确的方式在重组文本中放置评论。就个人而言，我当然也不喜欢 one-liner .. 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一样，可以从文档中提取评论列表。
于 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 回答