HTML注释--如何在HTML中注释掉一行或一个标签

600 阅读4分钟

在这篇文章中,你将学习如何在你的HTML文档中添加单行和多行注释。

你还会看到为什么注释被认为是编写HTML代码时的一个好做法。

让我们开始吧!

HTML注释标签

HTML注释的一般语法是这样的:

<!-- I am a comment! -->

HTML中的注释以<!-- 开始,以--> 结束。

不要忘记标签开头的感叹号!但你不需要在最后加上它。

该标签围绕着任何你想注释的文本或其他HTML标签。

何时使用HTML注释

HTML注释不在浏览器中显示。这意味着,当文档在网络浏览器中呈现时,你添加到HTML源代码中的任何注释都不会被显示。

尽管如此,请记住,任何人都可以通过访问View -> Developer -> View Source ,查看互联网上发布的几乎所有网站的源代码--这也包括所有的评论!因此,你的评论对其他人来说是可见的。

因此,如果你把HTML文档公开,并且他们选择查看源代码,你的评论就会被其他人看到。

写评论是很有帮助的,这也是写源代码时应该遵循的一个好的做法。注释可以帮助你记录和交流你的代码和思考过程,让你自己(和其他人)了解。当你在几个月不工作后回到一个项目时,它也会提醒你你在想什么/做什么。

评论还可以帮助你与其他和你一起做项目的开发者沟通。你的注释可以向他们清楚地解释你为什么要添加某些行的代码。

如何在HTML中写单行注释

一个单行注释只跨越一行。如前所述,这一行不会在浏览器中显示。

当你想解释和澄清后面的代码背后的目的时,或者当你想给自己添加这样的提醒时,可以使用单行注释:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>
</head>
<body>
    <!-- Add the navbar here -->
    <h2>About me</h2>
    <p>I am learning to code with freeCodeCamp.</p>
    <p>I am going through each and every one of their awesome and super helpful  certifications. </p>
    <p>I am on my way to becoming a fullstack web developer!</p>
    <h3>Work Experience</h3>
</body>
</html>

当你想清楚一个标签在哪里结束时,单行注释也很有用。这在一个长而复杂的HTML文档中很有用,因为那里有很多事情要做,你可能会对一个结束标签的位置感到困惑:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>
</head>
<body>
    <section class="contact">
    </section> <!--closing tag of contact section is here-->
</body>
</html>

如何在HTML中写内联注释

你也可以在一个句子或一行代码的中间添加注释。

只有<!-- --> 里面的文字会被注释出来,而标签里面的其他文字不会受到影响:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>
</head>
<body>
    <p>I am <!--going to be--> a web developer</p>
</body>
</html>

如何在HTML中写多行注释

评论也可以跨越多行,使用的语法与你目前看到的完全相同:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>
</head>
<body>
    <p>I am  a web developer</p>
    <!--This is going to be my portfolio.
    It will show off the projects that I'm most proud of.
    I could go on and on about what I want to add
    because I am writing a multi-line comment here-->
</body>
</html>

如何在HTML中注释掉一个标签

那么,如果你想在HTML中注释一个标签呢?

你可以用<!-- --> ,把你选择的标签包起来,像这样:

!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>
</head>
<body>
    <h2>My portfolio page</h2>
    <h3>freeCodeCamp certification projects</h3>
    <!-- <section class="hero">
    </section>  -->
    <h2>About Me</h2>
</body>
</html>

注释出标签有助于调试。

当某些东西不能按照它应该的方式或你希望的方式工作时,就开始一个一个地注释掉个别标签。这可以让你测试它们,看看是哪一个造成了问题。

添加HTML注释的键盘快捷键

你可以使用快捷键来添加注释--而且你可能最终会经常使用它们。Mac用户的快捷键是Command / ,Windows和Linux用户的快捷键是Control /

要添加一个单行注释,只需在代码编辑器中按住上面的组合键。然后你所在的整行就会被注释掉。请记住,由于该行的所有内容都将被注释掉,这只适用于单行注释。你需要手动添加内行注释。

对于添加多行注释,选择并高亮显示所有你想注释的文本或标签,然后按住前面的两个键。现在你选择的每一行都会有一个注释。

总结

现在你知道如何以及为什么要在HTML中使用注释了吧!

谢谢你的阅读,祝你学习愉快 :)