Html 如何在重新构造的文本中注释字符串？

HTML的注释是

，如何使用重组文本创建此注释块？按顺序排列，我如何注释掉重组文本中的某些行？

检查：

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

:

任意缩进的文本可能跟在 显式标记开始并将被删除 作为注释元素处理

也可以将注释与双点放在同一行：

.. Avoid this type of comment

---

但是，这被认为是一种不好的做法，因为如果注释与适当的标记结构相匹配，可能会导致意外的后果，正如@CecilCurry在中指出的那样。

对于注释，请添加两个句点

。

后跟一个换行，然后缩进注释

例如：

..
  comment goes here

---

请原谅这个重复的回答，因为我正试图帮助像我这样的RST新手。我的回答显示了评论的上下文

我天真地尝试使用上面的答案在RST文档中标记一行，DONOT执行以下操作：

    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格式化程序）不会抱怨，但“hi everyone”将出现在输出中。相反，在您的评论前后放置一个空行，如下所示：

    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

注释语法等价的语法，这些语法可以使某些文本完全消失。

我遇到了这个线程，正在寻找一种更明确的方法来将注释放置在StructuredText中。就个人而言，我当然也不喜欢单行程序

。。这是一条评论

。为了保持评论的可搜索性和可识别性，我建议考虑使用

.. only:: comment

    This is a comment

如文档所述（）：“未定义的标记为false”，例如

comment

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

.. comment::
    This is a comment

---

当然，在没有这种扩展的情况下这样做会从构建器中发出错误消息。但是有了这样的扩展，就像todo一样，可以从文档中提取注释列表。

如果有一个例子，这个答案会更好。这是一个糟糕的答案。重新构造的文本注释的条件使问题过于复杂。在这里，一个简短的“RTFM”后跟一行引号是不够的。在词汇上，什么是和什么不是有效的注释取决于该注释的内容以及用于指定该注释的语法。它不平凡，不明显，而且非常脆弱。@CecilCurry:就像RST中的其他东西一样。@mhsmith-每种语言都有它的结构和语法规则。RST不受这一不变法则的影响。作为这一有用答案的补充，第一种形式（即，

”。这是一条注释“

”）在实践中不应使用。基本上被认为是有害的。为什么？因为条件限制。以这种方式定义的任何注释，如果其第一行与任何现有显式标记结构（例如，引用、指令、脚注、替换）的语法相匹配，将被无声地重新解释为该结构，而不是注释——这很可怕。为了避免这种情况，请无条件地在所有注释前面加一行“

”。“

语句，如上述示例的其余部分所示。考虑到Cecil Curry所述，如果@jball首先修改其示例以显示理想的形式，那将是非常好的，这样我就不必阅读所有的细节，而只需在其余部分添加一条臭注释。另外，我已经假设我可以把我想要的任何东西放进注释中，所以其他示例中的所有额外符号只会使原本简单的答案变得复杂。。。除非这些是相关的。是吗？@CecilCurry谢谢你的洞察力，我用它更正了我的

ryd

文档（因此我们再次见面！）第1行

也是如此。

第2行

这是一条评论

好吗？也就是说，您能从第一个示例的第2行删除

\uu

和

：

？它运行良好，但不确定其含义。使用

？（点-点-点-点-点-点-点-点-点-点-点-点-点-点-点-点-点-点-点-点-点-点-点-点-点-点-点-点-点-点-点-点-点-点-点-点。。。
.. comment::
    This is a comment