关于代码规范

关于代码规范

目录

关于代码规范... 1

1)变量名... 1

2)方法名: 2

3)类名... 2

4)注释... 3

 

命名习惯,每当做一个框架或者看别人源码时,心里要建立一个完整树形结构编程图概念, 你知道了树形每一个分支，你就可以推出他有什么能力.

例如:写了一个基类的视窗BaseWindow,不管是副本,活动,商店,VIP模块,等等系统的视窗都继承基类的视窗.

1)变量名

var  参考类名

var bitmap:egret.Bitmap;      图片

var text:egret.TextField;        文本

再例如,有很多图片,普遍的做法,可以这样命名

var iconImg:egret.Image;     图标

var headImg:egret.Image;    头像

 

2)方法名:

动词(干什么)+名词()

例如:

public changeTxt():void{}  改变文本

public getImg():void{}       获取图片

public getItemByID(id:number):ItemVO  根据ID 获取物品信息

 

3)类名

名词(首字母大写)

例如:

BaseWindow       窗口基类

BaseModel          模块基类

BaseEvent           事件基类

NetManager 　   网络管理类

SocketManager   socket 通信管理类

SenceManager    场景管理类 

4)注释

一些公用的变量,命名会以下标为开始