如何在HTML代码中添加/取消注释

Question

通常在HTML中编写视图模板时，我的习惯是添加一些有益的注释，但这会导致测试过程中耗费大量时间。

考虑以下代码...

<!-- Here starts the sidebar -->
<div id="sidebar">
....
</div>

<!-- Here starts the main contents pane -->
<div id="main-contents">
...
</div>

<!-- Here starts the footer -->
<div id="footer">
...
</div>

现在，如果我需要隐藏视图模板的某部分，在php中，我只需选择所需的代码并放置单行注释（大多数情况下使用快捷键）。

然而，在仅支持块级注释的HTML代码中，我最终会将所有关闭注释标记（-->）删除到我想要进行注释的位置 - 就像这样...

<!-- Here starts the sidebar
<div id="sidebar">
....
</div>

<!-- Here starts the main contents pane
<div id="main-contents">
...
</div>

<!-- Here starts the footer
<div id="footer">
...
</div>-->

测试完成后，我必须经历痛苦的过程，重新添加那些闭合标签。

在HTML中是否有更好且节省时间的块注释方法？

- vikmalhotra

Answer 1

是的，将结构元数据注释掉

在.html文件中使用<script>/* ... */</script>

注释掉大段HTML（注释块）

我个人在.html文件中的方法是打开：<script>/*，然后用*/</script>关闭它。

<script>/* 隐藏代码放在这里 */</script>

这是解决问题的一种变通方法，因为它不是HTML。

考虑你的代码在.html文件中...

  <!-- Here starts the sidebar -->
  <div id="sidebar">
  ....
  </div>

<script>/*
  <!-- Here starts the main contents pane -->
  <div id="main-contents">
  ...
  </div>

  <!-- Here starts the footer -->
  <div id="footer">
  ...
  </div>
*/</script>

如果在HTML文件中使用PHP标签，可以使用注释标签<?/*或<?php /*将其包含，并使用*/?>进行结束。请记住，文件必须是.php扩展名，而不能在.html中工作。

<?/* 这里放置隐藏代码 */?>

考虑您的代码在.php文件中...

  <!-- Here starts the sidebar -->
  <div id="sidebar">
  ....
  </div>

<?/*
  <!-- Here starts the main contents pane -->
  <div id="main-contents">
  ...
  </div>

  <!-- Here starts the footer -->
  <div id="footer">
  ...
  </div>
*/?>

值得注意的是，这并不是HTML，而是常见的开发者惯例，即注释掉元数据的部分，以便在浏览器中不会被呈现和/或执行。在HTML中，注释多行可能需要花费很长时间。将包含注释、CSS或代码的模板结构元数据片段排除在外，并系统地注释掉，以找到错误的源头是很有用的。 注释块被认为是一种不好的做法，建议使用版本控制系统。 在HTML4中，“type”属性是必需的，在HTML5中是可选的。

- Alan Mattano

---

在 .html 文件中使用 <script>/* ... */</script> 是非常聪明的做法！ - Velojet

Answer 2

这取决于文件扩展名。如果是 .html 扩展名，你可以使用 <? 开始注释，?> 结束注释。这是我所能想到的唯一替代方法。 http://jsfiddle.net/SuEAW/

- Robert

---

选择 HTML 代码 => 使用 Ctrl+K 进行注释或取消注释。 - Palash Roy

Answer 3

你可以尝试将-->替换为另一个字符串，比如#END#，当你想要返回闭合标签时，可以使用编辑器进行搜索和替换。

- u11

Answer 4

在您的头部注释的“-->”之间加上空格，例如："- ->"。

- user3178029

Answer 5

我认为这也是XML样式文档注释的弊端。像Eclipse这样的XML编辑器可以执行block commenting。基本上，它会自动每行添加额外的 以及移除它们。也许他们特意把对那种文档样式的注释变得困难，因为毕竟标签应该能够自我解释。

- whatnick

Answer 6

我的视图模板通常是 .php 文件。目前我会使用这个。

<?php // Some comment here ?>

这个解决方案与@Robert建议的非常相似，对我很有效。我想它不是很干净。

- vikmalhotra

Answer 7

以下代码可在 .php 文件中正常运行。

<php? /*your block you want commented out*/ ?>

- dstrong

Answer 8

Eclipse Juno有一个很好的方法。你只需要按下cmd+/即可。

- scrblnrd3

Answer 9

不行，除非你找到一个能为你完成所描述工作的工具。

- David

Answer 10

根据您的编辑器，编写这个宏应该是相当容易的。

• 转到行首或突出显示区域
• 插入 <!--
• 转到行尾或突出显示区域
• 插入 -->

另一个宏来反转这些步骤，然后您就完成了。

编辑：这种简单的方法不能处理嵌套的注释标记，但应该可以使一般情况下的注释/取消注释更容易。

- Jeff Knecht

---

这样做行不通，因为中间的任何 --> 都会结束注释，这不是他想要的。他希望能够轻松地注释掉一个块，而无需手动删除中间所有的 -->，然后在结尾重新添加它们。 - Brian Campbell