[HTML]如何写出注释!介绍便笺和方便使用

“注释掉有意义吗?这只是一条备忘录。”

什么时候使用“注释掉”?

这些是开始编写HTML代码的人们肯定会遇到的问题之一。许多人都认为将评论保留为“个人笔记”,但实际上,将其保留在代码上是工程师必不可少的基本技能。

这次,我将向刚开始编写代码的人解释“保留工作记录的重要性”。开始编码的人们倾向于专注于学习诸如标签之类的功能,而忘记获得诸如“注释”之类的辅助技能。因此,我希望您首先了解这项辅助技能的重要性。阅读本文之后,您应该对什么是“正确的编码”有更好的了解。

[对于初学者]仔细解释如何编写CSS(样式表)

的HTML基础知识!什么是注释掉?

注释掉的定义

 在编写代码时,您经常会“注释掉”。
“注释掉”是指未在编辑器的面朝上浏览器中显示的“字符(注释)”和“代码”。
首先,要知道您可以在编辑器中留下“注释”和“不想显示的代码”。另外,在浏览器上显示已被“注释掉”的内容称为“取消注释”。

例如 ...

例如,下面的代码由“ h标签”和“ p标签”组成。

它看起来应该像这样:

“注释掉”此代码的“ p标记”。

然后,显示如下。您会看到“ p标记”未显示在浏览器上。

根据语言的不同,注释类型不同

 注释掉取决于语言。这次我将解释HTML注释,并非所有语言都能以相同的方式发表评论。特别是与HTML一起使用的CSS具有不同的方法。

1行注释掉 多个注释掉
的HTML <!– 注释掉一部分 –> <!–

注释掉一部分

–>

的CSS / *注释部分* / / *

注释掉一部分

* /

Java脚本 //注释掉一部分 / *

注释掉一部分

* /

的PHP //注释掉一部分

#注释掉一部分

/ *

注释掉一部分

* /

红宝石 #注释掉一部分 =开始

注释掉一部分

=结束

注释掉的效果

如果我不注释掉该怎么办?

考虑在代码中不加注释的缺点。以下模式是常见的。

  1. 我忘记了“关闭标签”,显示了一个错误,花了我很长时间才找到问题。
  2. 从“开始标签”到“结束标签”的范围已经扩大,并且很难知道在哪里写什么。
  3. 结果,当我稍后回顾时,我必须从一开始就了解要更改的内容以及如何进行更改。
  4. 我从另一个来源编写了代码,却不了解它,因此我不得不重新检查代码的含义。

 这些导致工作效率低下。如果您是一个人工作或有时间,这不会打扰您,但是如果您与多个人一起工作并且要编码为公司,则必须进行更改。留下“评论”的行为具有防止这种低效率的作用。

注释目的

注释掉的目的是为了提高“可读性”(使任何人都易于阅读代码)和“维护”(使任何人都易于更改代码)。通过执行以下四件事,“可读性”和“维护性”都将得到改善。

  1. 消除错误。
  2. 了解页面的结构。
  3. 快速更新信息。
  4. 个人笔记

减少代码错误

参见下图。全部为封闭标签。在编写长代码时,它包含许多元素,并且很难理解一个元素的位置和位置。如果您错过了一个“关闭标签”,您会注意到吗?

那么,为什么不这样对结束标记发表评论呢?您可以看到哪个结束标签对应于开始标签。结果,即使缺少标签,也可以立即找到它。实际上,您不必在每个结束标记上留下注释,但是如果您的代码很长,则是个好主意。

使标签结构易于理解

进行编码时,有些人会沿着页面的结构创建一个整体的上层框架元素,然后逐渐创建下层元素。到那时,如果您只能首先理解上层元素的范围,那么代码将“容易看清”,并且在进行协作编码时不会造成混乱。最重要的是,稍后查看时很容易修复代码。

例如,下面首先定义组件,然后相应地编写详细代码。 “注释掉”使每个元素的范围和内容一目了然。

快速更新信息。

即使代码本身是完整的,您也可能希望分阶段将其发布在浏览器上。在这种情况下,请在公共阶段通过注释掉并取消注释来删除完成的代码。这样,您可以立即更新信息。例如,如果您不想发布它,请按以下方式删除它。

在发布阶段,如果您取消注释,它将立即显示在浏览器中。

个人笔记

发表评论,以一种易于理解的方式解释您编写的代码。在下文中,假设您不了解“ navbar-fixed-top”的作用。通过留下注释来帮助您理解代码,这样就不会因为不懂而意外删除代码。

如何注释和注释

在计算机上操作:快捷键

您必须注释掉自己的语言,但不必记住和输入。您可以使用快捷键轻松注释掉。记住快捷方式以获取正确的注释。 (取决于编辑器的设置。)

视窗 苹果电脑
注释掉(一行) Ctrl + / 命令+ /
注释掉(多行) Ctrl + Shift + / 命令+ /

命令+选项+ /

的HTML注释掉

在HTML5和HTML 5.1中,“<!–」と「–>被“”包围的部分被定义为“评论部分”。

注意连字符的数量

连字符的数量为“–」と連続した2つ是。一个常见的错误是“—」や「———这是为了更改连字符的数量,例如“-”。不对

创建自己的休息时间,不要评论。

学习初期的一种常见做法是创建自己的休息并将其注释掉。例如,假设您自己创建元素到元素的分隔符,如下所示:

这样一来,您将无法注释掉。那是,「<!–」と「–>包围的区域中不应有连续的连字符因为有人说。

作为测试,”–让我们在文本中添加“”并注释掉。

毕竟,您无法将其注释掉。

您不能注释掉包括注释在内的句子。

例如,假设您已经注释掉了特定的部分,如下图所示。现在不显示“标题”部分,因此我想注释掉它。你能做到吗?

结果,它无法完成。您不能注释掉(嵌套注释掉)包含注释掉的代码。起初这是一个常见的错误。

在浏览器中看不到的东西与看不到的东西不同。

实际上,注释项不会出现在浏览器中。这并不意味着注释对第三方不可见。您可以查看注释。

例如,假设您在注释中写出了网站特定部分的更新时间表,如下所示。当然,它不会显示在浏览器上。

但是,例如,如果您使用“验证”工具进行检查,则可以将注释签出,如下所示。因此,您不能编写任何内容,也不应编写高度机密的信息。

概要

对于正确的编码,仅“编写代码”是不够的。将其设置为注释掉,并针对任何人都易于阅读的代码,而不是只有您可以理解的代码。尤其是如果要编写的代码量逐渐增加,那么采用页面结构的代码至关重要。如果您对高效的工作特别关注,请使用它。

撰写本文的人

田中 陽介

我在越南开展业务,并且从事与人事相关的咨询业务。我离开日本已经八年了,我享受着日本不可能发生的事情。最近,我正在使用Ruby on Rails进行Web服务。