本节书摘来自异步社区《JavaScript面向对象编程指南》一书中的第2章,第2.7节,作者: 【加】Stoyan Stefanov 译者: 凌杰 更多章节内容可以访问云栖社区“异步社区”公众号查看。
2.7 注释
现在,我们来看本章最后一个内容:注释。通过注释这种形式,我们可以将自己的一些想法放在JavaScript代码中。由于注释中的内容会被JavaScript引擎自动忽略掉,因此它们不会对程序产生任何影响。而当您几个月后重新考虑这段代码,或将其转让给其他人维护时,这些注释就会显得非常重要。
注释的形式主要有以下两种。
单行注释——以//开头并直至该行结束。
多行注释——以/ 开头,并以/结尾,其中可以包括一行或多行内容。但要记住,注释首尾符之间的任何代码都将会被忽略。
具体示例如下:
甚至,有些实用工具(例如JSDoc)可以从我们的代码中提取相关的注释,并据此生成有意义的项目文档。