FLASH编程规范
1. 目的
对于代码,首要要求是它必须正确,能够按照程序员的真实思想去运行;第二个的要求是代码必须清晰易懂,使别的程序员能够容易理解代码所进行的实际工作。通过建立代码编写规范,形成开发小组编码约定,提高程序的可靠性、可读性、可修改性、可维护性、可继承性和一致性,可以保证程序代码的质量,继承软件开发成果,充分利用资源,使开发人员之间的工作成果可以共享。
2. 要求
2.1. 程序结构清析,简单易懂
2.2. 打算干什么,要简单,直接了当,代码精简,避免垃圾程序。
2.3. 不要随意定义全局变量,尽量使用局部变量。
2.4. 保持注释与代码完全一致。
2.5. 每个源程序文件,都有文件头说明,说明规格见规范.
2.6. 每个函数,都有函数头说明,说明规格见规范
2.7. 变量定义或引用时,注释能反映其含义
2.8. 处理过程的每个阶段都有相关注释说明。
2.9. 利用缩进来显示程序的逻辑结构.
2.10. 注释可以与语句在同一行,也可以在上行。
2.11. 一目了然的语句不加注释。
2.12. 减少外界联系,考虑独立性或封装性。
3. 规范
3.1 命名规范
命名必须具有一定的实际意义, 任何一个实体的主要功能或用途必须能够根据命名明显的看出来。因为ActionScript是一个动态类型的语言,命名最好是包含有代表对象类型的后缀。一般而言,名词_动词和形容词_名词之类的语法是最常用的命名方式,如:
影片名字:my_movie.swf
URL实体:course_list_output
组件或对象名称:chat_mc
变量或属性:userName
方法和变量的名称应该以小写字母开头,对象和类应该大写。命名变量的时候使用大小写混和的方式,并且使用字母打头,还可以包含数字和下划线。
良好的命名规范还可以使用Flash的代码提示功能。下面我规范一下
公式:名称描述_类型缩写
xxx_str
xxx _array.
xxx _txt.
xxx _mc.
xxx_xml.
xxx _xmlnode
xxx _xmlsocket.
xxx _btn.
xxx _lv.
xxx _lc.
xxx _cam.
xxx _mic.
xxx _cm.
xxx _date.
xxx _err.
xxx_mcl.
xxx_nc.
xxx _ns.
xxx _fmt.
xxx _sound.
xxx _video.
这样就能使用Flash的代码提示功能的了。
如果你在描述性的变量名之前加上一个小写的字母,就可以很容易的分辨该变量是全局的还是本地,或者是作为一个参数来传递。
字母 含义 例子
g 全局变量 gMyGlobal
t 局部变量 tMyVar
s 代码局部 var* sMyVar
p 参数 pMyParam
k 常数* kMyNumber
u 用户自定义的属性 uMyProp
一些常用的命名变量和参数的建议:
●在你的代码的第一行就声明所有的全局变量.
●要节俭的使用全局变量,全局变量通常在你的代码中很难寻找,因为全局变量可能出现在任何的地方,但是如果你需要使用全局变量,就要使用全局变量.
●变量名一定要具有描述性,请不要用这样的变量名"temp," "var1," 或者那些没有含义的名字,应该用这样的名字"tProjPath."
● 上述原则的一个例外是计数器,因为它的功能就是在循环中计数,通常地,计数器都用小写的变量名 "i" 以及后续的字母 (下一个用 "j," 然后是 "k," 和 "l.") 除非你要建立一个嵌套的循环,否则不要使用 "j" 等.
3.2 注释规
文件开头的注释模板
/******************************************************************
** 文件名:
** Copyright (c) 1998-1999 *********公司技术开发部
** 创建人:
** 日 期:
** 修改人:
** 日 期:
** 描 述:
**
** 版 本:
**--------------------------------------------------------------------------*/
函数开头的注释模板
/*****************************************************************
** 函数名:
** 功能描述:
** 参数变量说明
****************************************************************/
程序过程中注释看你的方便就OK了。
以上是AS1.0都适用,AS2.0也大部分适用,但是AS2.0中出现了私有属性(private)和公有属性(public)
我们声明的时候最后区分开,在定义私有属性是我们前面加个”_”,例如_nStep
下面是个规范的例子。
1. 目的
对于代码,首要要求是它必须正确,能够按照程序员的真实思想去运行;第二个的要求是代码必须清晰易懂,使别的程序员能够容易理解代码所进行的实际工作。通过建立代码编写规范,形成开发小组编码约定,提高程序的可靠性、可读性、可修改性、可维护性、可继承性和一致性,可以保证程序代码的质量,继承软件开发成果,充分利用资源,使开发人员之间的工作成果可以共享。
2. 要求
2.1. 程序结构清析,简单易懂
2.2. 打算干什么,要简单,直接了当,代码精简,避免垃圾程序。
2.3. 不要随意定义全局变量,尽量使用局部变量。
2.4. 保持注释与代码完全一致。
2.5. 每个源程序文件,都有文件头说明,说明规格见规范.
2.6. 每个函数,都有函数头说明,说明规格见规范
2.7. 变量定义或引用时,注释能反映其含义
2.8. 处理过程的每个阶段都有相关注释说明。
2.9. 利用缩进来显示程序的逻辑结构.
2.10. 注释可以与语句在同一行,也可以在上行。
2.11. 一目了然的语句不加注释。
2.12. 减少外界联系,考虑独立性或封装性。
3. 规范
3.1 命名规范
命名必须具有一定的实际意义, 任何一个实体的主要功能或用途必须能够根据命名明显的看出来。因为ActionScript是一个动态类型的语言,命名最好是包含有代表对象类型的后缀。一般而言,名词_动词和形容词_名词之类的语法是最常用的命名方式,如:
影片名字:my_movie.swf
URL实体:course_list_output
组件或对象名称:chat_mc
变量或属性:userName
方法和变量的名称应该以小写字母开头,对象和类应该大写。命名变量的时候使用大小写混和的方式,并且使用字母打头,还可以包含数字和下划线。
良好的命名规范还可以使用Flash的代码提示功能。下面我规范一下
公式:名称描述_类型缩写
xxx_str
xxx _array.
xxx _txt.
xxx _mc.
xxx_xml.
xxx _xmlnode
xxx _xmlsocket.
xxx _btn.
xxx _lv.
xxx _lc.
xxx _cam.
xxx _mic.
xxx _cm.
xxx _date.
xxx _err.
xxx_mcl.
xxx_nc.
xxx _ns.
xxx _fmt.
xxx _sound.
xxx _video.
这样就能使用Flash的代码提示功能的了。
如果你在描述性的变量名之前加上一个小写的字母,就可以很容易的分辨该变量是全局的还是本地,或者是作为一个参数来传递。
字母 含义 例子
g 全局变量 gMyGlobal
t 局部变量 tMyVar
s 代码局部 var* sMyVar
p 参数 pMyParam
k 常数* kMyNumber
u 用户自定义的属性 uMyProp
一些常用的命名变量和参数的建议:
●在你的代码的第一行就声明所有的全局变量.
●要节俭的使用全局变量,全局变量通常在你的代码中很难寻找,因为全局变量可能出现在任何的地方,但是如果你需要使用全局变量,就要使用全局变量.
●变量名一定要具有描述性,请不要用这样的变量名"temp," "var1," 或者那些没有含义的名字,应该用这样的名字"tProjPath."
● 上述原则的一个例外是计数器,因为它的功能就是在循环中计数,通常地,计数器都用小写的变量名 "i" 以及后续的字母 (下一个用 "j," 然后是 "k," 和 "l.") 除非你要建立一个嵌套的循环,否则不要使用 "j" 等.
3.2 注释规
文件开头的注释模板
/******************************************************************
** 文件名:
** Copyright (c) 1998-1999 *********公司技术开发部
** 创建人:
** 日 期:
** 修改人:
** 日 期:
** 描 述:
**
** 版 本:
**--------------------------------------------------------------------------*/
函数开头的注释模板
/*****************************************************************
** 函数名:
** 功能描述:
** 参数变量说明
****************************************************************/
程序过程中注释看你的方便就OK了。
以上是AS1.0都适用,AS2.0也大部分适用,但是AS2.0中出现了私有属性(private)和公有属性(public)
我们声明的时候最后区分开,在定义私有属性是我们前面加个”_”,例如_nStep
下面是个规范的例子。
回复Comments
作者:
{commentrecontent}