美文网首页
(二)JavaScript——注释

(二)JavaScript——注释

作者: 清葉 | 来源:发表于2017-02-11 19:33 被阅读0次

           上一篇(一)JavaScript——变量的最后我们提出了一些问题,其中有一个问题是//是什么东西?很明显他是一个符号,他的作用也比较明显,就是注释掉一部分代码。原来如此,那么在JavaScript的世界里有哪些注释的符号哪?注释都是用在什么地方哪?注释的作用都有哪些哪?什么样的注释习惯才是好的注释习惯哪?恩,带着这些问题,我们一起来思考思考吧!

    JavaScript世界中有两种注释,他们的样子如下所示:

    1:单行注释

    //我写的代码的时候明显比较帅

    2:多行注释

    /*我代码的时候确实比较帅*/

    很简单嘛!确实比较简单,注释那有一个特性,就是注释起来的代码或者别的什么东西都不会被执行了。有意思吧!

    那注释都是用在什么地方,这个要分情况来论啦!

    单行注释基本常用的地方有两种:

    1:行首,比如://var age=66;代表这一行代码都不会被执行了

    2:行中,比如:var age=66;//好吉利的年龄,代表//之后的文字不会被执行了

    多行注释就比较牛逼了,随便用,想用在哪里都行,比较自由自在的,比如:

    1:/*var age=66;*/

    2:/*吉利年龄*/var age=66;

    3:var /*吉利年龄*/age=66;

    4:var age=66;/*吉利年龄*/

    很简单嘛!确实很简单,本来就简单嘛!不过我觉得,也挺挺重要的,尤其是注释的作用,以及良好的代码注释习惯,相当的重要!

    那注释有什么用哪?让某些代码不被执行呗!还能有啥!确实是这样,不过也不完全如此的,比如,我认为注释的作用有下面几个:

    1:提高代码的可读性,我们可以人类的语言给一段复杂的代码加点简单描述的,这样就容易理解了

    2:提高代码的可维护性,当我们进入一家新公司,接手一个老项目,但是代码统统没有注释,你能想象有多头疼吗?

    3:方便代码的调试,我们想换一种思路来实现一个方法,但是又不确定能否能实现,最好我们先保留好原来的代码

    4:对于有些代码我们不仅想知道他的功能是什么,我们还想知道他的作者是谁?什么时候编写的?代码的重要性?入参?返回值?等等,这时候注释就会显得格外的引人注目了

    5:方便自己找bug,方便后来人接手,利于回想和描述代码的实现逻辑等等

    6:免于被骂或者鄙视,以及得到他人的认同和尊重

    看看,注释的作用不小吧!那有哪些好的注释习惯哪?时间和精力允许的情况下代码注释能够让新人一下就能明白最好不过了!好的注释习惯我觉得有如下几个:

    1:代码必须有

    2:风格必须统一

    3:注释需要表明是谁写的?什么时候写的?干什么用的?入参是什么?出参是什么?

    4:核心代码,复杂代码,关键变量必须有注释

    5:写注释时对应的注解要使用正确

    好了!谢谢这些吧!

    相关文章

      网友评论

          本文标题:(二)JavaScript——注释

          本文链接:https://www.haomeiwen.com/subject/ajnwittx.html