被注释的代码块在JavaScript之中是不会被运行的。注释是一个非常好的方式可以让你自己以及其他人明白这段代码是怎么运行的。
JavaScript中的注释方式有以下三种:
使用 //
通知JavaScript来忽略当前行的代码
// This is an in-line comment.
你也可以使用多行注释来注释你的代码,以/*
开始,通过*/
来结束,参考如下代码:
/* This is a
multi-line comment */
文档注释 /** 文档注释内容 */
最佳实践
在编写代码时,应该通过添加注释来让你的代码看起来更加地清晰易懂。良好的注释能够清晰地传达你写的代码的意图,便于你或者他人在阅读你的代码时能更快的理解这段代码的意图。