注释 | HTML5资源教程

本文是 html5tricks原创翻译，转载请看清文末的转载要求，谢谢合作！

摘要——注释简单代码会干扰对重要注释的理解。程序开发者最好能用最精要的注释来解释重点代码。

举个例子，你打开一个电箱，里面有几百根电线，蒙了吧。再一看，每根电线上面都有一个整洁的小标签。真是谢天谢地啊！但是，当你一个个去翻看标签的时候，见鬼的，几乎所有的标签都是空白的！

然后，在你花了整整一个小时去浏览每一个小标签之后，终于给你找到12条有用的信息，真心喜大普奔！当然，希望在你头脑一片混乱的时候得出的结果仍然是正确的，没有遗漏，呵呵呵。

当我需要研究代码的时候看到到处都是垃圾注释，唉，我的感觉就和上面在那么多标签里面找有用的一样。见鬼的，想从一大堆垃圾注释里确定哪个有用简直就像大海捞针！

说一个常用的开源项目，里面都是这些垃圾注释：

/**
* __construct function.
*
* @access public
* @return void
*/
public function __construct() {

…
}

再来一个：

/**[......]

本文带大家来学习一下HTML注释的使用，相对其他编程语言，HTML的注释比较复杂一点，HTML注释标签是<!–…–>，凡是在这个注释标签里的内容都不会被浏览器显示内容，比如下面的HTML代码：

<!--这是一段HTML注释。它将会在浏览器中隐藏。-->

<p>这是一段普通的文字，它将在浏览器上正常显示。</p>

上面的代码可以看到，第一行文字在注释范围内，将不会显示在浏览器上，第二行将正常显示。

另外，HTML注释标签<!–…–>还可以用在Javascript中，看以下Javascript代码：

<script type="text/javascript">
<!--
function alertErr()
{
alert("这是一个Error!")
}
//-->
</script>

这里注释的作用是让不支持Javascript脚本的浏览器忽略在注释标签里的代码，而不会在浏览器中显示这些代码文本。注意：注释行结尾处的两条斜杠 (//) 是[......]

标签归档：注释