首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

js里面如何注释

在JavaScript(JS)中,注释是用来解释代码的,它不会被浏览器执行。JS支持两种类型的注释:单行注释和多行注释。

  1. 单行注释:使用//符号来标记。从//开始到该行结束的所有内容都会被浏览器忽略。例如:
代码语言:txt
复制
// 这是一个单行注释
let x = 5; // 这里也可以添加单行注释
  1. 多行注释:使用/*开始,*/结束。在这两个符号之间的所有内容都会被浏览器忽略,不论它有多少行。例如:
代码语言:txt
复制
/*
这是一个
多行注释
*/
let y = 10;

应用场景

  • 当你想解释某段代码的功能或目的时。
  • 当你在调试代码,想临时禁用某段代码时。
  • 当你想为其他开发者或未来的自己留下关于代码的说明时。

优势

  • 提高代码的可读性。
  • 有助于代码的维护和调试。
  • 为团队协作提供便利。

总之,合理地使用注释可以使你的代码更加清晰易懂,从而提高开发效率。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

idea里面的注释模板

目录 类注释 方法注释 类注释 打开 IDEA 的 Settings,点击 Editor–>File and Code Templates,点击右边 File 选项卡下面的Class,在其中添加图中红框内的内容...: /** * @author jing * @date ${YEAR}年${MONTH}月${DAY}日 ${TIME} */ 方法注释 根据形参数目自动生成 @param 注解 根据方法是否有返回值智能生成...@Return 注解 相较于类模板,为方法添加注释模板就较为复杂,首先在 Settings 中点击 Editor–>Live Templates。...还记得我们配置 Template text 时里面包含了类似于 d a...: '\\r\\n * @return ' + \"${_1}\"", methodReturnType()) 注:你还注意到我并没有勾选了 Skip if defined 属性,它的意思是如果在生成注释时候如果这一项被定义了

97910
  • 【js】如何正确的写代码注释?

    错误注释 你的注释是不是这样的? //时间戳日期格式化函数 function formTime(time,isyear){ } 亦或者是这样的?...、易维护、易理解,起到提示的作用的,上面的两个注释都是正确的,但是它起到的作用太低了,在正式工作中我们往往会协同开发,这种注释是万万不可的。...正确注释 正确的注释 就是文档注释,先来看看是什么样子。...普通注释 文档注释 这种提示就像嵌代码在里面一样,而不是浮于表面了,在我们书写npm包的时候,用户使用我们的包,就能看到这种提示,对使用者特别友好。...npm install jsdoc -g 基本使用 jsdoc 文件名 其他的使用方式可以去官网查看 jsdoc 33.js 执行完此命令,会生成一个out文件夹,查看里面的index页面即可,右边侧边栏会显示函数的使用

    20920

    如何编写高质量的 JS 函数(2) -- 命名注释鲁棒篇

    本文首发于 vivo互联网技术 微信公众号 链接:https://mp.weixin.qq.com/s/sd2oX0Z_cMY8_GvFg8pO4Q 作者:杨昆 上篇 《如何编写高质量的 JS 函数(...1) -- 敲山震虎篇 》介绍了函数的执行机制,此篇将会从函数的命名、注释和鲁棒性方面,阐述如何编写高质量的 JS 函数。...从图中可以看到 egg.js 的入口文件的注释特点是简单整洁。 继续看下图: ?...2、lodash.js 说到函数注释,就不能不说到 lodash.js 。由于篇幅有限,本文就不做相应介绍了,大家自行按照上面的方式去了解。...那如何去更好的处理各种异常,提高函数的鲁棒性呢,我个人有以下几点看法。 4、推导一下 try/catch 的原理 js 在 node.js 提供的运行时环境中运行,node.js 是用 C++ 写的。

    1.4K20

    混合到同一个10X样品里面的多个细胞系如何注释

    我给学徒的建议是根据文章里面的描述,去CCLE数据库,以及GEO数据库,找到里面的各种细胞系的芯片或者测序的表达量矩阵,然后对这个单细胞降维聚类分群后的8个细胞亚群取表达量平均值。...手动注释如下: # st ep4....手动注释细胞类型------ # cluster0 MCF7 # cluster1 HEK293 # cluster2 T47D # cluster3 BCK4 # 排除法 # cluster4...另外,cluster3 对应的 BCK4 也是没办法命名,因为我们整理好的细胞系矩阵里面本来就没有它。 ?...www.bilibili.com/video/BV19Q4y1R7cu/ section 3已更新,「生信技能树」单细胞公开课2021 如果是简单的降维聚类分群,可以参考前面的例子:人人都能学会的单细胞聚类分群注释

    54330

    混合到同一个10X样品里面的多个细胞系如何注释

    我给学徒的建议是根据文章里面的描述,去CCLE数据库,以及GEO数据库,找到里面的各种细胞系的芯片或者测序的表达量矩阵,然后对这个单细胞降维聚类分群后的8个细胞亚群取表达量平均值。...手动注释如下: # st ep4....另外,cluster3 对应的 BCK4 也是没办法命名,因为我们整理好的细胞系矩阵里面本来就没有它。...上游分析流程 02.课题多少个样品,测序数据量如何 03. 过滤不合格细胞和基因(数据质控很重要) 04. 过滤线粒体核糖体基因 05....去除细胞效应和基因效应 06.单细胞转录组数据的降维聚类分群 07.单细胞转录组数据处理之细胞亚群注释 08.把拿到的亚群进行更细致的分群 09.单细胞转录组数据处理之细胞亚群比例比较

    57231

    如何在 Python 中注释

    另外一个提高代码可读性的方式就是使用注释。一个注释就是可以用来解释代码的一段人类可读的解释或者一个注解。例如,如果你写了一个复杂的正则表达式,你可以添加一个注释,描述代码做了什么。...很可能你不记得为什么你写了一些比较复杂的代码,除非你添加一段注释。这个注释同时也可以帮助其他开发者理解你的代码,以及代码的目的。 注释应该很短,并且切中要点。不要解释那些很容易读懂的代码。...本文主要讲解在 Python 中编写注释的基础知识。 一、在 Python 中写注释 Python 会忽略井号(#)后面的一切。 注释可以添加到行首或者和其他代码在一行。...注释在调试脚本的时候非常有用。...仅仅支持单行注释。

    1.4K20

    Scala里面如何使用枚举

    枚举通常用来定义已知数量的常量,比如月份,星期,季节等等,用过java的人都知道定义枚举的关键字是enum,在scala里面和java有所不同,来看一个完整的例子定义: 上面的这个例子基本涵盖了枚举的所有常用方法...,定义枚举我们继承的是Enumeration抽象类,然后通过内部对象Value来赋值每一个枚举的值,此外里面还定义了几个工具方法,比如判断是否存在某个枚举,是否是工作日,以及打印所有的枚举值,在使用的时候可以直接通过...此外还可以用枚举值做模式匹配: 上面基本就是Scala里面最常见的枚举方法了,当然这种常见的枚举有一些缺点,比如上面的这个模式匹配,如果我仅仅写3个枚举值,它编译时候仍然能通过,但在运行的时候就会报错,

    1.1K50

    pycharm加注释的快捷方式_pycharm如何批量注释

    1、主题   在开发项目的过程中经常需要创建任务列表,对于一些小任务,在代码中插入便签注释会有奇效。   ...这种注释的格式如下:   2、创建便签注释   非常简单:   首先,将光标定位到相应行。   然后,创建一行注释(Ctrl+Slash)。   ...只要注释满足以上格式,就会在TODO tool window窗口中显示。   这里我们介绍如何创建其他格式的便签。   ...在Patterns部分单击绿色加号,输入如下正则表达式:   同时更改图标和配色方案:   设置完成后Pycharm会自动检测当前工程中的所有注释,若发现符合条件的便签注释,则会以新的配色方案在...创建一个注释行,输入rv,按下TAB:   输入文本,回车:   模板生效。

    2.6K20
    领券