Javascript类及成员命名约定

来源:互联网 发布:wifi定位软件 编辑:程序博客网 时间:2024/05/02 02:29
给自己约定的一个Javascript语法规范,以便以后的代码更加清晰易读。
 
每个类必须有一个自定义的构造函数,可以有一个自定义的析构函数。
 
类的构造函数(自定义)只能由类自身调用。
 
类中只能包含类成员的声明,类成员的赋值只能在构造函数(自定义)中。
 
类成员的位置按照其可访问级别归类。
 
例如:
 
function Person()
{
  /* 成员变量 */
 
  /* private: */
  var name;
  var id;
 
  /* protected: */
  this._name;
  this._id;
 
  /* public: */
  this.Name;
  this.Id;
 
  /* 成员函数 */
 
  /* private: */
  function get_age()
  {
 
  }
 
  /* protected: */
  this._GetAge = function(){}
 
  /* public: */
  this.GetAge = function(){}
}
/* 静态成员变量 */
Person.prototype.Age = 100;
 
/* 静态成员函数 */
Person.prototype.GetName = function(){}
 
对受保护的成员访问仅限于类或从类派生的类型。
 
命名规范:
 
1、类名首字母大写,类名使用名词。
例如:
function Event(){}
 
2、类的私有属性首字母小写,如果属性名由多个词组成,词与词之间以_间隔。
例如:
function Event(){
  var message_id = null;
}
 
3、类的公有属性或静态属性首字母大写,如果属性名由多个词组成,每个词的首字母大写。
例如:
function Event(){
  this.MessageId = null;
}
或者
function Event(){};
Event.prototype.MessageId = null;
 
4、类的受保护属性以_开始,如果属性名由多个词组成,每个词的首字母大写。
例如:
function Event(){
  this._MessageId = null;
}
 
5、类的私有方法首字母小写,一般方法名使用 动词+名词 的形式,词与词之间使用_间隔。
例如:
function Event(){
  function construct_class()
  {
  }
}
 
6、类的公有方法或静态方法首字母大写,一般方法名使用 动词+名词 的形式,每个词的首字母大写。
例如:
function Event(){
  this.ConstructClass = function()
  {
  }
}
或者
function Event(){}
Event.prototype.ConstructClass = function(){};
 
7、类的受保护方法以_开始,如果方法名由多个词组成,每个词的首字母大写。
例如:
function Event(){
  this._ConstructClass = function()
  {
  }
}