注释

注释

1.注释的定义

注释的英文是annotation，是指对书籍或文章的语汇、内容、背景、引文作介绍、评议的文字。

2.注释的起源

注释起源于先秦时期，在那个时候就有了对古书的注释。

3.为什么要有注释

注释是为了对一些文字的解释，一些不懂的事物的解释。

注释的对象不是自己，因为你自己写的东西自己肯定自己看的懂。关键在于虽然你看得懂，但是比人不一定看得懂。

就比如说古书，你是看懂了，但是别人看不懂，这时候你就需要根据你自己的理解，对一些别人看不懂的地方进行注释。

再比如说代码。首先，代码是你写的吧，那你自己就是懂得咯。但是呢，别人看不懂怎么办，你难不成跟每一个看不懂的人解释一下这句话是干嘛的吗？这里就需要注释了，你注释了，别人就能看懂了。但是注释你也要尽量描述的清晰，不然就白注释了。

4.注释的原则

1）注释形式统一

在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同，按照这份规范写代码，不要试图在既成的规范系统中引入新的规范。

2）注释内容准确简洁

内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。

6.注释的快捷键

注释的快捷键是“ctrl” + “/”两个按钮，这个是单行注释。首先你需要选中你要注释的内容，然后先按“ctrl”，在按“/”，然后代码就会被注释了。

也可以是使用“ctrl” + “shift”  + “/”，这个是多行注释。这里教你们一个方法，同时按三个的方法：你可以先按住“ctrl”键，然后再按“shift” ，最后在按“/”。

5.注释的条件条件

一般来说，我们不会无缘无故的注释。因为那样不仅会增加我们的书写量，而且也会把代码变得不简洁。

基本注释：全局变量的注释、函数的注释、链接的注释、对象的注释。

特殊注释：在一些代码不明处添加注释。

下通同过案例说明：

<div class="header"><!--头部-->
    <div class="content"><!--内容-->
        <div class="logo"><!--logo-->
            <img src="../img/logo.png" alt="logo图片"/>
        </div>
        <div class="nav1"><!--导航栏-->
            <ul>
                <li><a href="index.html" target="_self">首页</a></li>
                <li><a href="download_app.html">app下载</a></li>
                <li><a href="about.html">关于我们</a></li>
                <li><a href="partner_apply.html">招商</a></li>
                <li class="phone">400-1234-123</li>
            </ul>
        </div>
    </div>
</div><!--头部-->

上面是一个HTML界面的编写，他添加了好多注释，让我们一看就看的懂，好理解。

记住，一个不会注释的码农不是一个好的程序员，一个没有注释的代码块不是一个好的代码块。

6.注释分类

注释有多种：

1）在HTML中的注释：

格式是<!--内容-->,内容写在中间，这个可以单行注释，也可以是多行注释。

<!--1.这是HTML中的单行注释-->
<!--2.这个是第二行-->

也可以这样一起注释，

<!--1.这个HTML中的多行注释
2.这个是第二行-->

这样都是可以实行注释的。

2）在css中的注释：

格式是/*内容*/，内容也是写在中间，也是可以单行和多行注释。

/*1.这个是在css中的单行注释
2.这是第二行*/

/*1.这个是在css中的多行注释*/
/*2.这是第二行*/

3)在js中的注释：

这个js中的注释比较特别，他有两种格式：分别是单行注释和多行注释。单行和多行注释使用的符号不一样。

首先是单行注释，这个注释格式是//，两个斜杠。代表的是该行斜杠后面的内容被注释了。

//1.这个是在js中的单行注释
//2.这是第二行

下面是多行注释，注释格式与css一样，使用的也是/*内容*/形式。

/*1.这个是在js中的多行注释
2.这是第二行*/

在java中注释与js的注释一样，使用的方法也是相同的的。

7.注释的特点

在代码中注释还有别的意义。他可以注释你所写的代码，然后你注释的代码就不会执行。

    var sum = 0;
    sum+=1;
    sum+=2;
     /* sum+=3;
    sum+=4;*/
    sum+=5;
    alert(sum);

比如说上面的代码，他把中间两行代码注释了。

没注释以前，sum是15,；注释了以后sum是8.

这就证明了注释了的代码不会被执行。

所以在代码中注释也是扮演一种很重要的角色，他既可以解释代码，也可以注释代码。

总结

注释很重要！注释很重要！注释很重要！

在代码中尽量多写注释，要让别人看的懂，但是也不要写一些没用的注释。

当你写代码的时候，你的注释就是你与别人的交流语言，代表的是你的意思。