在脚本标签内使用 HTML 注释是最佳实践吗?
在尝试理解在脚本标签内使用 HTML 注释是否是最佳实践之前，我们先来讨论一下如何在 HTML 中编写注释，以及在 HTML 中有哪些不同的注释方式?
通常，注释有助于理解语句，它能提供补充说明。在测试或开发新功能时，它还有助于禁用语句。
语法
以下是注释表示的语法 −
<!-- statement-->
让我们看看在程序中表示注释的不同方法 −
插入单行注释
单行注释适用于包含开始标记和结束标记的单个语句，例如 <!-- -- >。我们将插入这些注释来提醒代码中发生了什么。
注意 − 注释标记中不应包含空格，例如 <!-- 是无效的。标记内可以包含任意数量的空格，但标记必须表示为 <!--，不带空格。
示例
以下示例展示了如何表示单行注释 −
<html> <head> <title> Single line comment</title> </head> <body> <!—paragraph begins here --> <p> TutorialsPoint Website</p> </body> <html>
运行上述代码时，将显示单行注释"Tutorialspoint website"。
如何创建多行注释
使用多行注释可以跨越多行，这有助于解释复杂的代码。
示例
以下示例展示了如何在 HTML 中表示多行注释。
<html>
<head>
<title> Multiline comments</title>
</head>
<body>
<!—
TutorialsPoint is having a technical content website Where we can find all technical related information with Content as well as videos
-->
<p> TutorialsPoint WEBSITE </p>
</body>
<html>
运行上述代码时，输出结果将以多行注释的形式显示。
如何使用注释功能快速禁用代码
我们可以使用注释功能快速阻止代码执行。当我们尝试跟踪错误或试图阻止代码在页面上运行时，只需删除注释标签即可轻松恢复代码。
示例
以下示例展示了如何使用注释功能快速禁用 HTML 中的代码。
<html> <head> <title>Comment function for quickly disable code</title> </head> <body> <p>Images related to Courses</p> <img src="https://www.cainiaomax.com/images/ncert-books-class-6-maths_icon.svg" height=150 width=150><br><br> <!-- Hiding this image for now <img src="/images/pic2.jpg height=150 width=150"><br> --> <img src="https://www.cainiaomax.com/images/statistics_icon.svg" height=150 width=150> </body> </html>
运行上述程序时，与课程文本相关的图片将与图片一起显示。
注释功能可在不支持的浏览器上隐藏脚本
如果我们使用 JavaScript 或任何其他脚本语言，我们会使用注释功能在不支持的浏览器上隐藏脚本。为了确保脚本在支持的浏览器上正常工作，我们必须在脚本开头插入注释，并以 //--> 结尾。
示例
以下示例展示了如何使用注释功能在不支持的浏览器上隐藏脚本。
<html>
<head>
<title>JavaScript</title>
</head>
<body>
<script language="javascript" type="text/javascript">
<!--
document.write("Hello World!")
//-->
</script>
</body>
</html>
示例
请考虑一个示例，该示例解释了在 HTML 中编写注释是否是最佳实践。
JavaScript 可以通过放置在 <script>... </script> 中的 JavaScript 语句来实现。
</script>. <script ...> JavaScript code </script>
示例
HTML 注释添加在 <script> 标签中，可选 −
<html>
<body>
<script>
<!--
document.write("Hello World!")
//-->
</script>
</body>
</html>
相关文章
有用资源
html 参考教程 - 该教程包含有关 html 的更多信息:https://www.cainiaomax.com/html/
