...
|
...
|
@@ -11,25 +11,24 @@ |
|
|
* 建议将编辑器Tab映射成4个Space
|
|
|
|
|
|
## 注释
|
|
|
* 为每个你创建的JS文件添加注释
|
|
|
```html
|
|
|
* 为每个你创建的JS文件添加注释
|
|
|
```
|
|
|
/**
|
|
|
* 对文件实现功能的描述
|
|
|
* \@date: 2016-11-11
|
|
|
* \@author: name<emial@yoho.cn>
|
|
|
* @date: 2016-11-11
|
|
|
* @author: name<emial@yoho.cn>
|
|
|
*/
|
|
|
```
|
|
|
* 为重要的函数添加注释
|
|
|
```html
|
|
|
/**
|
|
|
* 对函数功能的说明
|
|
|
* \@params name paramType 参数描述
|
|
|
* \@return name returnType 返回值描述
|
|
|
* 为重要的函数添加注释
|
|
|
```
|
|
|
/**
|
|
|
* 对函数功能的说明
|
|
|
* @params name paramType 参数描述
|
|
|
* @return name returnType 返回值描述
|
|
|
*/
|
|
|
```
|
|
|
* 为重要的代码、逻辑复杂的代码或者有特殊处理的代码添加注释
|
|
|
```html
|
|
|
|
|
|
* 为重要的代码、逻辑复杂的代码或者有特殊处理的代码添加注释
|
|
|
```
|
|
|
// Your comments for the code
|
|
|
```
|
|
|
* 减少不必要的注释
|
...
|
...
|
|