1、命名规范:命名法、变量、常量、构造函数、类的成员等等的命名规范
命名法:
// 匈牙利命名法(前缀字母用变量类型的缩写,其余部分用变量的英文或英文的缩写,单词第一个字母大写)
let mCount = 10;
// 驼峰命名法(第一个单词首字母小写,后面其他单词首字母大写,简单粗暴易学易用)
let maxCount = 10;
// 帕斯卡命名法(小驼峰式命名法的最大区别在于,每个单词的第一个字母都要大写)
let MaxCount = 10;
// 下划线命名法(要求单词与单词之间通过下划线连接即可) 现在常用于常量(全大写)
const MAX_COUNT = 10;
变量:
命名方法:驼峰命名法
命名规范:前缀应当是名词。(函数的名字前缀为动词,以此区分变量和函数)
命名建议:尽量在变量名字中体现所属类型,如:length、count等表示数字类型;而包含name、title表示为字符串类型。
// good
let maxCount = 120;
// bad
let setCount = 110;
常量
命名方法:下划线命名法。
命名规范:使用大写字母和下划线来组合命名,下划线用以分割单词。
const URL = 'http://www.baidu.com';
const MAX_COUNT = 120;
构造函数:
介绍:在JS中,构造函数也属于函数的一种,只不过采用new 运算符创建对象。
命名方法:大驼峰式命名法,首字母大写。
命名规范:前缀为名称。
function Student(name) {
this.name = name;
}
var st = new Student('tom');
类的成员:
1、公共属性和方法:跟变量和函数的命名一样。
2、私有属性和方法:前缀为_(下划线),后面跟公共属性和方法一样的命名方式。
function Student(name) {
let _name = name; // 私有成员
// 公共方法
this.getName = function () {
return _name;
}
// 公共方式
this.setName = function (value) {
_name = value;
}
}
var st = new Student('tom');
st.setName('jeck');
console.log(st.getName()); // => jeck:输出_name私有变量的值
2、注释规范:单行注释、多行注释以及函数注释
单行注释:
// 调用了一个函数;1)单独在一行
setTitle();
var maxCount = 10; // 设置最大量;2)在代码后面注释
// setName(); // 3)注释代码
多行注释:
/*
* 代码执行到这里后会调用setTitle()函数
* setTitle():设置title的值
*/
setTitle();
函数(方法)注释(常用注释关键字):
注释名 | 语法 | 含义 | 示例 |
---|---|---|---|
@param | param 参数名 {参数类型} 描述信息 | 描述参数的信息 | @param name {String} 传入名称 |
@return | @return {返回类型} 描述信息 | 描述返回值的信息 | @return {Boolean} true:可执行;false:不可执行 |
@author | @author 作者信息 [附属信息:如邮箱、日期] | 描述此函数作者的信息 | @author 张三 2015/07/21 |
@version | @version XX.XX.XX | 描述此函数的版本号 | @version 1.0.3 |
@example | @example 示例代码 | 演示函数的使用 | @example setTitle('测试') |
/**
* 合并Grid的行
* @param {Grid} grid 需要合并的Grid
* @param {Array} cols 需要合并列的Index(序号)数组;从0开始计数,序号也包含。
* @param {Boolean} isAllSome 是否2个tr的cols必须完成一样才能进行合并。true:完成一样;false(默认):不完全一样
* @return void
* @author polk6 2015/07/21
* @example
* _________________ _________________
* | 年龄 | 姓名 | | 年龄 | 姓名 |
* ----------------- mergeCells(grid,[0]) -----------------
* | 18 | 张三 | => | | 张三 |
* ----------------- - 18 ---------
* | 18 | 王五 | | | 王五 |
* ----------------- -----------------
*/
function mergeCells(grid, cols, isAllSome) {
// Do Something
}