JS前端开发规范

前端开发规范

插件开发规范

总则

开发js插件，需要尽量减少对其他库的依赖，尽量使用js原生语法。
必须编写插件的开发使用文档以及插件使用的demo。

命名规则

项目命名

使用全小写方式，多个单词使用减号“-”分割。
示例：csui-list （译为：川顺科技列表插件项目）

目录命名

使用全小写方式，多个单词使用减号“-”分割（尽量使用单个词语）；
名词有复数结构时，未使用缩写时要采用复数命名法。
示例：

• images（缩写：img；译为：图片存放文目录）
• scripts（缩写：js；译为：脚本存放目录）
• styles（缩写：css；译为：样式存放目录）

文件命名

使用全小写命名，多个单词使用减号“-”分割；文件属性使用英文句号“.”分割。
示例：echarts-all.min.js（译为：echartst图表完整版压缩包/库）。
常用文件属性约定：

• min 压缩

html元素自定义属性命名

使用小驼峰命名法，遵循html5自定义属性命名规范，使用data-前缀。
示例：

• data-code(译为：元素内容对应的code编码值)

函数命名

使用小驼峰命名法，前缀应为动词。
示例：常用动词约定：getName（译为：获取姓名）。
常用动词约定：

• get 获取
• set 设置
• load 加载
• is 判断

变量命名

使用小驼峰命名法，尽量在变量名中体现属性。
示例：tableTitle（译为：表格标题）。

常量命名

使用全大写，多个单词使用下划线“_”分割。
示例：

• COORDS_TYPE（译为：地理坐标类型）。

类/构造函数命名

使用大驼峰命名法。
公共属性和方法：跟变量和函数的命名一样。
私有属性和方法：前缀为下划线“_”，后面跟公共属性和方法一样的命名方式。
示例：

class UserInfo{
	private _name:string;
		getName(){
		return this.name;
	};
};

注释规范

总则

代码中的每个函数和关键业务逻辑都需要添加注释说明。

行内注释

行内注释以两个斜线“//”开始，以行尾结束。一般用来对单个变量进或调用方法行说明。
示例：

page.init();  // 页面初始化
var userName =””;  // 用户姓名，初始为空

单行注释

单行注释以两个斜线“//”开始，以行尾结束。一般用来对接下来的业务做一个说明或代码单行过长是使用。
示例：

// 获取参数并进行合法性验证
var userName = document.getElementById(“name”).value();
var userAge = document.getElementById(“age”).value();
var isLegal = app.userInfoLeagal(userName,userAge);

多行注释

以 “/” 开头，由“/”结尾。一般用来对函数进行说明。
常用注释名约定：

• @author 作者信息说明
  语法：@ author作者信息 [附属信息：如邮箱、日期]
• @param 传入参数说明
  语法：@param {类型} 参数名描述信息
• @return 返回参数说明
  语法：@ return {类型} 参数名描述信息
  示例：

/**
 * 获取用户信息
 * @author 杨小辉 [991865986@qq.com 2010-01-01]
 * @param {string} code 传入用户编码
 * @return {user} user返回用户对象
 */
function getUserInfo (code){
	var user = { };
	retrun user;
};