如何在 HTML 属性中进行评论？

Posted 2023-02-21

【中文标题】如何在 HTML 属性中进行评论？

【英文标题】：How to comment within an HTML attribute?

【发布时间】：2012-12-10 19:47:46

【问题描述】：

下面代码中的最后一个（闭合）尖括号不会被解释为闭合<input>元素：

<input type='text' name='name' <!-- id='name' -->>

我认为这是注释掉此属性的有效方法，但 Google Chrome、Firefox 和 Notepad++（颜色编码）都表明这不是要走的路。

我在 Notepad++ 中使用 CTRL+Shift+Q 来做到这一点。

那么注释掉这个<id>属性的正确方法是什么？

【问题讨论】：

为什么要评论？如果不使用则删除

只去掉id属性？

【参考方案1】：

html 无法在标签内放置注释。

---

如果您是从模板/编程语言生成 HTML，那么您可以使用它的特性来注释掉一些东西。

例如在 Template-Toolkit 中：

<input type='text' name='name' [%# id='name' %]>

或 php：

<input type='text' name='name' <?php # id='name' ?>>

---

如果您使用的是 HTML 5，那么您可以（作为一个丑陋的黑客）使用数据属性来“注释”整个属性。

<input type='text' name='name' data-comment-id='name'>

【讨论】：

这真的很糟糕。在某些情况下，最好暂时禁用“class”或“id”等属性。

谢谢，我其实是在学习 PHP，但是这个是手写的！

最初的目标是通过使用 Notepad++ 快捷键注释掉内容来节省自己的打字时间。适用于 CSS 和 PHP，但显然并非总是适用于 HTML :-(

【参考方案2】：

我通常只是将_x 放在属性名称的末尾。然后该属性被忽略，因为它是未知的。因此，如果我想从此元素中注释掉 id 属性：

<input type="text" name="name" id="name">

我会改成这样：

<input type="text" name="name" id_x="name">

这还有一个好处是可以搜索“_x=”来查找所有评论的属性。

【讨论】：

显然这个技巧应该只在开发时使用，并且“注释”属性不应该留在生产代码中。

【参考方案3】：

<input type='text' name='name' <?php  /* id='name' */ ?> >

您可以使用它，它在查看源信息时不会被解释

【参考方案4】：

如果你想在 HTML5 中注释一行而不使用

<!-- Html comments -->

你可以使用

咏叹调标签

例如：

 <button aria-label="Close" nclick="myDialog.close()">X</button>

或

<button aria-label="This button close the popup" nclick="myDialog.close()">X</button>

由于没有表明按钮的目的是关闭对话框，因此 aria-label 属性用于为任何辅助技术或简单的 cmets 提供标签。

【参考方案5】：

我同意，你不应该在这个地方使用 cmets。也就是说，以下内容应该适用于 Chrome、Firefox 和 IE：

<input type="text" %id="test1"% class="test2">

【讨论】：

这会将<input type="text" %="" %id="test1"> 放入 DOM，这太可怕了。

在 Chrome 中它呈现 <input type="text" %id="test1" % class="test2">。