个人 ActionScript 命名规则

http://frozensun.cn/2009/12/328#comment-170

团队开发过程中少不了要阅读其他成员写的代码,如果每个人都使用自己的一套命名规则,对开发的和谐度是会有比较大影响的。好的命名规则可以让人一眼看出其类型,作用域等。

以下是本人常用的变量命名规则(以下所有命名规则都基于驼峰式命名法,即:多个单词组成的名称除第一个单词外都将首字母大写):

1、变量的命名规则

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
//静态变量(全大写,以"_"分开各单词)
public static const GAME_SCENE: String = "gameScene";
public static const STAGE_WIDTH: Number = 800;
 
//类公共变量(全小写,无前缀,驼峰式)
public var level: Number = 1;
public var stateName: String = "myState";
 
//类私有变量 (以单下划线开头+类型前缀)
private var _sLevel: String;
private var _mMovie: MovieClip;
 
//类局部变量(以双下划线开头+类型前缀)
var __nLevel: Number = 22;
var __oTarget: Sprite;
 
//形参变量(以"$"开头)
private function funcName($arg1:Type, $arg2:Type):void

常用类型前缀格式:

名称 类型 前缀缩写
数值 Number
unit
int
n
字符串 String s
布尔值 Boolean b
数组 Array a
影片剪辑 MovieClip m
按扭 Button btn
文本 TextField txt
声音 Sound snd
其它实例对象 Object o
普通函数 Function f
事件函数 Event Function e


2、类命名规则

1
2
3
4
//一般类(首字母大写,能简捷明了表达出类的意图)
public class GameScene {}
//接口(以字母I作为首字母,名称的首字母也大写)
public interface IPlants {}

3、包命名规则

1
2
//首字母小写
plantsGame.ui.plants

4、类代码结构和注释规则
按如下顺序定义类中各变量和方法,注释越详细越好。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
/**
* 描 述:类的作用描述
* 作 者:类的创建者
* 创建日期:年.月.日(如08.04.19)
* 修改日期:年.月.日(如08.04.19)
*/
package 包路径
{
	import …
	pubic Class 类名 …(是否继承和实现接口)
	{
		//注释出每个变量的意思,顺序如下
		静态变量
		公共变量
		私有变量
 
		//构造函数,注释出各个参数代表的意思
		pubic function 构造函数名(参数1:类型, 参数2:类型, …)
		{
		}
 
		//公共函数,注释出各个参数代表的意思
		pubic function 函数名(参数1:类型, 参数2:类型, …):返回值
		{
		}
		公共方法2…
		公共方法n…
 
		//重载函数,注释出各个参数代表的意思
		override 作用域 funciton 函数名(参数1:类型, 参数2:类型, …):返回值
		{
		}
 
		//私有函数,注释出各个参数代表的意思
		private function 函数名(参数1:类型, 参数2:类型, …):返回值
		{
		}
		私有方法2…
		私有方法n…
	}
}

Comments are closed.