js规范

mac2022-06-30  91

一、命名规范

  1 .变量: 小驼峰式(小写字母开始,后续每个单词首字母都大写)

  命名:前缀应当是名词。(函数的名字前缀为动词,以此区分变量和函数)

  建议:尽量在变量名字中体现所属类型,如:length、count等表示数字类型;而包含name、title表示为字符串类型。

     多个变量声明 用一个 var 即可,每个变量占一行,方便注释。

     在函数体讲所有的var声明的东西都拿到函数体顶部。

  示例:

// 好的命名方式 var maxCount = 10,tableTitle = 'LoginTable'; // 不好的命名方式 var setCount = 10; var getTitle = 'LoginTable';

 

myname = "global"; function sample() { alert(myname); // "undefined" var myname = "local"; alert(myname); // "local" } sample();

 

 2.函数

  命名:大驼峰式(每个单词首字母都大写)

  规范:前缀应当为动词

  示例:

  

// 是否可阅读 function canRead() { return true; } // 获取名称 function getName() { return this.name; }

  3.常量

  命名:名称全部大写

  规范:使用大写字母和下划线来组合命名,下划线用以分割单词。

  示例:

var MAX_COUNT = 10; var URL = 'http://www.baidu.com';

  4.构造函数

  介绍:在JS中,构造函数也属于函数的一种,只不过采用new 运算符创建对象。

  命名:小驼峰式命名法,首字母大写。

  规范:前缀为名称

  示例:

function Student(name) { this.name = name; } var st = new Student('tom');

  5.类成员

  ① 公共属性和方法:跟变量和函数的命名一样。

  ② 私有属性和方法:前缀为_(下划线),后面跟公共属性和方法一样的命名方式。

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私有变量的值

二、注释

  1.单行注释

  调用了一个函数,单独在一行

  变量,在变量后面注释

  2.多行注释

  说明:以/*开头,*/结尾

  使用方法:

  ① 若开始(/*)和结束(*/)都在一行,推荐采用单行注释。

  ② 若至少三行注释时,第一行为/*,最后行为*/,其他行以*开始,并且注释文字与*保留一个空格。 

  语法:

  /**   * 函数说明   * @关键字   */

三、其他

  for循环判断条件里尽量不要使用涉及到DOM操作的动作。 

for (var i = 0, max = myarray.length; i < max; i++) { // logic }

  函数参数里“,”后空一格、函数声明中花括号前空一格、函数表达式中括号前后各空一格,如:

func(a, b, c){}; function func() {}; var func = function () {};

所有的操作符前后都跟一个空格,如:

var d = 0, a = b + 1; if (a && b && c) { d = a % c; a += d; }

 

转载于:https://www.cnblogs.com/hjsblogs/p/6323590.html

相关资源:Js代码规范
最新回复(0)