注释是使您的代码更具可读性的描述性文本。

对程序员来说，写注释和写代码一样重要。

但是，如果您是初学者，那么担心您应该留下什么样的注释也是一个问题。

所以这一次，我将解释如何写一个基本的注释。

JavaScript 注释

注释用于描述代码。所以注释本身不会被评估为代码。

我们在之前的文章“新手入门必学的JavaScript代码规范详解”中稍微提到了这一点，这里我们重点在来讲一下如何写注释。

编写 JavaScript 注释的一般方法有两种：

//: 1 行注释

/* */: 多行注释

一行注释

单行注释，顾名思义，用于逐行留下注释。

// 一行注释

// 这部分不被识别为代码

//后面到行尾都会被识别为注释，//和文本之间一般会有一个空格。

基本上在记述简短的说明时使用。

//的同一行中所写的文本是注释，所以如果没有//换行的话，那这个部分就不是注释了。

// 1一行注释

换行的部分不是注释

多行注释

顾名思义，多行注释也用于以多行为单位留下的注释。

/*

多行注释

被包围的部分不被识别为代码

*/

/*和包围的部分*/被识别为注释。

/*和之间的文字*/一般用换行和缩进书写。

与单行注释不同，文本可以换行编写，因此在长文本注释时使用很方便。

需要注意的是不能在多行注释中编写多行注释。

在/**/中再嵌套/**/会导致语法错误。

/*

多行注释1

/*

多行注释2

*/

*/

类似 HTML 的注释

从ES2015追加的HTML-like注释方法，以与HTML注释相同的格式进行描述。

这一行也是注释

分别被识别为一行注释。

中间console.log()行作为 JavaScript 代码执行，因此输出"这行是JavaScript的代码"。

另外开始标记也可以从与代码相同的行的中途开始写。另一方面结束标记必须写在行的开头。

let num = 1; 结束标记必须在行的开头

同样，中间的代码作为 JavaScript 代码执行，所以它打印 1。

那么为什么会存在这样的规范呢？

它是有历史背景。过去不支持 JavaScript 的浏览器中无法识别

目前所有浏览器都支持