#### 注释
---
- 根据情况可使用单行注释`//`, 或多行区域注释`/** **/`;
- 注释注解是你和其他开发者相互了解代码释义的唯一途径，因此，在任何会产生歧义或产生大量复杂代码之前，以及在任何代码块之前都应添加注释注解；
- 注释为英文或中文均可，根据项目需求与情况而定;
- 注释注解应该表意为详细解释、说明其承上启下的含义与描述，在程序上下文中存在的意义,而非程序语法的中文释义;
- 使用标准注释符号来区别单行注释与多行注释；
- 如果为函数体等含有多参数代码，请在注释中使用@param符号来标注参数，参数个数与名称必须与实际程序参数保持一致;
> <span class="do">正确实践:</span>
```js
//初始化用户数据,构造用户数据时使用;
var users = {
name : "",
age : "",
level : 0
};
/**
* 项目全局获取用户数据的唯一接口,该接口只负责获取单一用户数去,不做用户权限等验证操作;
* @param userId { String } 用户ID
* @return {Object} 用户基础数据
**/
function getUserName(userId){
var getUserDeferred = $q.defer();
$http({
url : "/getUserName",
method : "POST",
data : {
userUuid : userId
}
}).then(function(res){
getUserDeferred.resolve(res);
},function(error){
getUserDeferred.reject(error);
});
return getUserDeferred.promise;
}
```
> <span class="dont">错误实践:</span>
```js
//声明一个对象
var users = {
name : "",
age : "",
level : 0
};
/**
* userId get用户ID
**/
function getUserName(userId){
var getUserDeferred = $q.defer();
$http({
url : "/getUserName",
method : "POST",
data : {
userUuid : userId
}
}).then(function(res){
getUserDeferred.resolve(res);
},function(error){
getUserDeferred.reject(error);
});
return getUserDeferred.promise;
}
```
