一、你可以在脚本的任何地方添加注释,它们并不会影响代码的执行,因为引擎会直接忽略它们。
二、单行注释以两个正斜杠字符//开始。
1、它可能独占一行或者跟随在一条语句的后面。
| 【示例】```javascript // 这行注释独占一行 alert(‘Hello’);
alert(‘World’); // 这行注释跟随在语句后面
|
| --- |
三、多行注释以一个正斜杠和星号开始“/*”并以一个星号和正斜杠结束“*/”。
| 【示例】```javascript
/* 两个消息的例子。
这是一个多行注释。
*/
alert('Hello');
alert('World');
注释的内容被忽略了,所以如果我们在/* … */中放入代码,并不会执行。
有时候,可以很方便地临时禁用代码:
/* 注释代码
alert('Hello');
*/
alert('World');
| | —- |
四、不要在/…/内嵌套另一个/…/
| 【示例】下面这段代码报错而无法执行:```javascript / / 嵌套注释 ?!? / / alert( ‘World’ );
|
| --- |
<a name="WJL3i"></a>
# 记录函数的参数和用法
一、有一个专门用于记录函数的语法[JSDoc](http://en.wikipedia.org/wiki/JSDoc):用法、参数和返回值。
```javascript
/**
* 返回 x 的 n 次幂的值。
*
* @param {number} x 要改变的值。
* @param {number} n 幂数,必须是一个自然数。
* @return {number} x 的 n 次幂的值。
*/
function pow(x, n) {
...
}
二、有一些像JSDoc 3这样的工具,可以通过注释直接生成 HTML 文档。你可以在http://usejsdoc.org/阅读更多关于 JSDoc 的信息。