注释的重要性

什么是注释

html 注释标签是使用来在 html 源代码中添加说明/注释,使用该标签注释的内容将不在浏览器中显示。边写代码边写注释是一个好习惯,特别是代码量很大的时候,如果不写代码,你写完倒回去看可能都不知道自己写的什么了。如果是团队合作,就更应该写注释了,如果不写鬼才知道你写的什么,还需要从头到尾仔细开一遍。

二、html 注释标签格式

语法格式:<!- 注释的内容 ->

注意:html 注释标签不支持任何的标准属性和事件!

三、html 标签应用

html 可以用在哪些地方呢?接下来我们就一起来看一看!

1、单行注释

<h1>html 注释标签的详细介绍</h1><!-- 文章标题-->

说明:通过注释一看就知道前面是文章的标题。

2、多行注释

<!--

<p>这是文章的一个段落</p>

<p>这是文章的一个段落</p>

-->

说明:在代码有bug的时候,可以用注释标签来排错!

3、条件注释

<script type="text/javascript">

<!--

这是一段JavaScript代码

//-->

</script>

在代码中如何注释

(1)在HTML代码中:

<body>

<!--HTML代码-->

<div>hello world!</div>

</body>

HTML中的给代码注释,只需要添加 即可,我们可以通过快捷键Ctrl+/来完成

(2)在CSS代码中:

<style>

div{

width:100px;

height:30px;

border:1px solid #ccc;

/*设置字体垂直居中*/

text-align: center;

line-height: 30px;

}

</style>

CSS中注释为/**/,快捷键为Ctrl+/

(3)JavaScript代码中

<script type="text/javascript">

        // 点击div时改变其背景颜色

        var div=document.getElementsByTagName("div")[0];

        div.onclick=function(){

            div.style.backgroundColor="pink"

        }

    </script>

JavaScript中注释为//,快捷键为Ctrl+/

学会注释的好处:

(1)有助于保持一致性

(2)有助于理解

(3)帮助修补程序或快速修复

(4)有助于加快开发过程

(5)有助于提高协作效率

首先,不愿意注释主要是因为懒惰,被懒惰束缚,为了赶工,甚至是对自己编程的信心。习惯是很可怕的一件事,习惯的力量很难被改变。很多人从开始编写学习编写程序时都是从几行代码量开始的,没什么可以注释的,慢慢随着学识的累计,代码量逐渐上升。然而,前期形成的错误观点影响了后期编程的习惯。作为一个职业工程师更要有写注释的习惯。

发布了15 篇原创文章 · 获赞 0 · 访问量 102

猜你喜欢

转载自blog.csdn.net/weixin_45806273/article/details/103282048
今日推荐