龙空技术网

如何让JavaScript代码注释变得更科学

小郑搞码事 1386

前言:

此时你们对“js快速加注释”大概比较注意,各位老铁们都需要分析一些“js快速加注释”的相关内容。那么小编在网摘上网罗了一些对于“js快速加注释””的相关内容,希望小伙伴们能喜欢,兄弟们快快来学习一下吧!

点击右上方红色按钮关注“小郑搞码事”,每天都能学到知识,搞懂一个问题!

代码注释也是有一定讲究的,要想让代码易读,易理解,那么写好注释也是非常重要的一环。下面这三个原则也许是我们写注释需要坚守的底线。一起来看一下。

原则一. 注释量

代码注释并不是越多越好,一定要注释到关键点,通常只有业务逻辑需要注释。如下代码对比。

原则二. delete注释代码

当你的代码时存在注释掉的代码时,赶紧把它们删掉,其中git存在的意义就是保存你的旧代码,所以注释掉的及时delete。如下所示

原则三. 不需要注释高亮

通常情况下,业务代码中注释掉的代码并不需要高亮来做提示,反而会干扰我们阅读代码。如下代码所示

标签: #js快速加注释