如何在javascript中添加注释?

更新日期: 2020-02-01阅读: 1.8k标签: 注释

代码注释对长久维护的项目来说很重要,随着前端代码逻辑日趋复杂,合理的文档注释能提高维护开发效率。尤其在多人团队中,良好的注释能降低沟通成本。

JavaSciprt注释不会被浏览器读取,会自动跳过,写注释对自己以后回过头来快速检查具有重要作用,写注释时尽量要写简明详细,下面来说一下注释的基本的三种方式。


使用//进行单行注释

在JavaScript中,单行注释由双正斜杠(//)表示,可以在语句之前和之后使用。

以//开头编写单行注释,任何位于//与行末之间的文本都会被JavaScript忽略。

语法

// 你的代码在这里


使用/*和*/进行多行注释

在JavaScript中,多行注释是用开始标记(/*)和结束标记(*/)编写的,即用带有星号的正斜杠(/ * * / )表示。

语法:

/* 注释内容 */

/*
  *  JavaScript多行注释
  * 在这里写注释内容
*/


使用<!-- 进行注释

语法:

<!-- 要注释的内容

虽然在严格模式没报错,但此种方式不建议使用,因为该方式易与 html 注释方式混淆。


链接: https://www.fly63.com/article/detial/8833

php代码中注释的含义

最近在梳理和优化手上的项目代码,这个项目已经走过好几任了,每一任的开发人员多多少少都有一些差异和各自的习惯,所以代码逻辑和写法上都有点【乱】。在代码中,注释是一个非常重要的信息

HTML 注释 和 实体字符

在HTML中还有一种特殊的标签——注释标签。如果需要在HTML文档中添加一些便于阅读和理解但又不需要显示在页面中的注释文字,就需要使用注释标签

条件注释的两种形式_下层隐藏与下层显示

条件注释 (conditional comment) 是于HTML源码中被 Microsoft Internet Explorer 有条件解释的语句。条件注释可被用来向 Internet Explorer 提供及隐藏代码。条件注释最初于微软的 Internet Explorer 5浏览器中出现

JS正则与注释的冲突

最近在写一款前端组件的时候,无意发现正则与注释之间的一点冲突,现分享下。猜测应该是正则没有使用引号,导致JS解析时将正则里边的*/做为了注释的结尾。

html代码中如何写注释?

HTML中的注释通常用于解释标记。在编辑源代码时,它将帮助您和其他人快速轻松地选择或查找文档中的特定部分;浏览器不会显示注释。那么如何在html代码中如何写注释?下面本篇文章就来给大家介绍一下,希望对大家有所帮助

javascript注释有几种?

代码注释对长久维护的项目来说很重要,随着前端代码逻辑日趋复杂,合理的文档注释能提高维护开发效率。尤其在多人团队中,良好的注释能降低沟通成本。

html注释代码怎么写?

HTML注释:不被程序执行的代码。用于程序员标记代码,在后期的修改,以及他人的学习时有所帮助。对关键代码的注释是一个良好的习惯。在开发网站或者功能模块开发时,代码的注释尤其重要。

如何写好代码注释?

对于代码注释来说,在不同的教程或者原则中有不同的规定或者解释。有的原则是需要使用 JavaDoc 来描写每个方法,而有的原则是要求每一个属性标注命名

为啥CSS不会支持双斜杠(//)注释?

相信大家对 CSS 的语法又有了一个新的认识,下面总结一下有部分属性值会出现双斜杠语法,比如border-image、-webkit-mask-box-image,不支持双斜杠注释最主要的原因是无法兼容现版本

内容以共享、参考、研究为目的,不存在任何商业目的。其版权属原作者所有,如有侵权或违规,请与小编联系!情况属实本人将予以删除!