如何在javascript中添加注释?

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

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

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


使用//进行单行注释

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

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

语法:

// 你的代码在这里


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

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

语法:

/* 注释内容 */

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


使用<!-- 进行注释

语法:

<!-- 要注释的内容

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


本文内容仅供个人学习、研究或参考使用,不构成任何形式的决策建议、专业指导或法律依据。未经授权,禁止任何单位或个人以商业售卖、虚假宣传、侵权传播等非学习研究目的使用本文内容。如需分享或转载,请保留原文来源信息,不得篡改、删减内容或侵犯相关权益。感谢您的理解与支持!

链接: https://shenqiku.cn/article/FLY_8833