本文目录
http常用方法
简单的URI命名规则
级联资源API URI命名规则
其他命名规则
变量命名规则
函数命名规则
常量命名规则
构造函数命名规则
类命名规则
注释规则
框架开发命名规则
APIURI命名注意要使用名词，而不是动词。
驼峰式命名方式
小驼峰：例：perPage 首字母小写
大驼峰：例：PerPage 首字母大写
参数命名设计规范
蛇形参数命名：per_page
小驼峰参数命名（帕斯卡命名）:perPage 首选
http常用方法：
get ,获取某个资源
post, 创建一个新的资源
put,替换某个已有的资源
patch,修改某个已有的资源
delete,删除某个资源
简单的URI命名规则
获取用户列表：GET/users
获取ID为1的用户：GET/users/1
创建一个用户：POST/users
创建一个ID为1的用户：POST/users/1
修改ID为1的用户：PATCH/users/1
替换ID为1的用户：PUT/users/1
删除ID为1的用户：DELETE/users/1
级联资源API URI命名规则
获取ID为1的用户下的产品列表：GET/users/1/products
获取ID为1 的用户下的产品ID为2的产品：GET/users/1/products/2
创建ID为1的用户下的产品：POST/users/1/products
创建ID为1的用户下的产品ID为2的产品：POST/users/1/products/2
替换ID为1的用户下的产品：PUT/users/1/products
替换ID为1的用户下的产品ID为2的产品：PUT/users/1/products/2
修改ID为1的用户下的产品：PATCH/users/1/products
修改ID为1的用户下的产品ID为2的产品：PATCH/users/1/products/2
删除ID为1的用户下的产品：DELETE/users/1/products
删除ID为1的用户下的产品ID为2的产品：DELETE/users/1/products/2
其他命名规则
如：要获取usersID为1下的分页查询的列表
表达混乱的URI：
[HttpGet]
[Route("api/wzlinks/users-{spaceUserId}/{pageIndex=1}/{pageSize=20}")]
public async Task<IEnumerable<WzLinkDTO>> GetPagedList(int spaceUserId, int pageIndex, int pageSize)
{
.....
}
优化后
[HttpGet]
[Route("api/users/{space_user_id}/wzlinks")]
public async Task<IEnumerable<WzLinkDTO>> GetPagedList(int space_user_id, int page, int per_page)
{
.....
}
优化后的URI：
api.cnblogs.com/api/users/1/wzlinks?page=1&per_page=20
变量：
命名方法：小驼峰
规范：前缀应当是名词
建议：尽量在变量名中体现所属类型，如length，count表示数字类类型，而包含name,title表示为字符串类型
如：var maxLength =10;
var tabTitle = 'unitTable'
函数：
方法：小驼峰
规范：前缀应当为动词
建议：可使用常见动词约定
20180904161609.png
如：
是否可读：
function canRead(){
return true;
}
获取名称
function getName(){
return this.name;
}
常量：
方法：名称全部大写
规范：蛇形命名法 即大写字母和下划线组合，下划线用以分割单词。
建议：无
如：
var URL='http://www.baidu.com';
var MAX_COUNT =10 ;
构造函数（采用new运算符创建）
方法：大驼峰式命名法
规范：前缀为名称
建议：无
如：
var maxCount = new Student('tom') ; 即Student
类的成员
类的成员包含：
公共属性和方法：遵循变量和函数的命名方式，即小驼峰命名法
私有属性和方法：下划线和小驼峰命名方法，即小驼峰命名方法前加_
如：
function Student(name) {
var _name = name; // 私有成员
// 公共方法
this.getName = function () {
return _name;
}
// 公共方式
this.setName = function (value) {
_name = value;
}
}
var st = new Student('tom');
st.setName('jerry');
console.log(st.getName()); // => jerry：输出_name私有变量的值
注释规范
普遍的注释规范
单行注释 //注释内容
单独一行 ，即注释与注释内容之间保留一个空格。
在代码后面添加注释 ，即注释与代码之间保留一个空格，注释与注释内容之间保留一个空格
注释代码，即注释与代码之间保留一个空格
多行注释 /* 注释内容 /
开始和结束都在一行，要使用单行注释
两行注释 ，第一行 /开头，第二行以/结尾
三行以上，第一行 /开头，中间以* 开始，最后一行以*/结尾
函数或者方法的注释规范，参照 javadoc(百度百科)。
个人理解就是对函数或者方法的说明性注释
/**
*函数（方法）说明
*/
部分
20180904164827.png
框架开发
概念：
全局变量冲突：在团队开发或者引入第三方JS文件时，有时会造成全局对象的名称冲突，比如a.js有个全局函数sendMsg() ，b.js也又有个全局函数sendMsg() ，引入a.js和b.js文件时，会造成sendMsg()函数冲突。
单全局变量：所创建的全局对象名称是独一无二的，并将所有的功能代码添加到这个全局对象上。调用自己所写的代码时，以这个全局对象为入口点。
命名空间：在项目规模日益壮大时，可采用命名空间方式对JS代码进行规范：即将代码按照功能进行分组，以组的形式附加到单全局对象上。
网友评论