(二)JavaScript——注释

       上一篇(一)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:写注释时对应的注解要使用正确

好了!谢谢这些吧!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,392评论 5 470
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,258评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 147,417评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,992评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,930评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,199评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,652评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,327评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,463评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,382评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,432评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,118评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,704评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,787评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,999评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,476评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,057评论 2 341

推荐阅读更多精彩内容