Flex有什么样的编码规范?

Flex有什么样的编码规范?,第1张

1 缩写:尽量避免使用缩写,使用缩写时尽量和Flex保持一致。但要记住一些通用缩写,如:acc(accessiblility) , auto(automatic), impl(implementation), info(infomation), num(number), min(minimum), max(maximum), nav(navigation), regexp(regularexpression), util(utility)等等。 2 文件名:MXML:各个单词首字母大写,如Mainmxml,FlvPlayermxmlCSS:小写字母开头,其余大写,如testStylecss 3类名:各个单词的首字母大写,如EditTestas 事件类(FoobarEventas) 命令类:TestCommandas 皮肤类(FooBarBackground, FooBarBorder, FooBarIcon), utility类(FooBarUtil,不是FooBarUtils,包是复数,类是单数); 4 包:l 小写字母开头,后面各个单词大写,比如controls, listClasses;包名称最好是名词或者动名词,不要用动词、介词、形容词、副词之类。当一个包的作用是实现某一功能的时候最好使用动名词,如bingding, logging, messaging, printing;支持组件FooBar的最好写作fooBarClasses;l 包的导入:使用完整的应用名,不要使用星号(),除非使用了包的绝大 部分l 包的第一部分使用顶级域(com,org,mil,edu,net,gov等)下一部分是所有者的名称,再是工程名和模块,如:cncomcompanyprojectmodule 5命名空间: 小写字母、下划线隔开,文件名必须与命名空间名称一致,如:mx_internal, object_proxy 6 接口名称: 字母“I”开始、大写字母间隔:IList, IFocusManager, IUID

7常量: 全部大写字母,下划线间隔:OFF, DEFAULT_WIDTH,如果常量是一个字符串,那么常量命名和常量值保持一致: <public static const FOO_BAR: String = "fooBar"> 8变量名:l 全局变量以类型缩写开头,并使用有意义的名称,如intCount,numCount,strName, Boolean的以is开头。l 临时变量通常使用一个常用字母,如:i,j,k,m,n。不要使用l(L)避免与1混淆l Catch中的变量必须使用el 变量尽量初始化 9 方法命名:小写字母开始,每个单词大写字母间隔,应该使用动词:measure(), updateDisplayList();无参方法应该实现为getter/setter,而不应该是getFooBar(), setFooBar();当然,如果getFooBar()是一个需要大量计算的慢速度方法的话就应该命名为findFooBar(), calculateFooBar(), determineFooBar()等等,而不是getter;如果子类的某方法覆盖了基类的某方法,但是同时又想继续公开基类的某方法,那么这个时候应将基类的方法名前加上“$”作为子类方法名,并且子类的方法名应该标志为final,且除了调用基类方法外不应该做其它的事情:mx_internal final function $addChild(child:DisplayObject):DisplayObject{ return superaddChild(child);} 10 事件处理器命名: 在后面加上Handler:mouseDownHandler();如果事件处理器是用来处理组件的某一个子组件的事件的话,那么就应该把子组件的名称加到最前面,并且用下划线隔开:textinput_focusInHandler() (textinput的focusin事件的handler); 11 参数命名:setter值使用value:public function set label(value:String):void;事件参数使用event:protected function mouseDownHandler(event:Event):void 12 属性名命名:小写字母开始,大写字母间隔:i, width, numChildren;使用i作为选还变量,n作为循环上界;使用j作为循环变量,m作为循环上界:for (var i:int = 0; i < n; i++){ for (var j:int = 0; j < m; j++) { }}使用p作为loop循环的变量:for (var p:String in o){ }如果子类的getter/setter覆盖了基类的getter/setter,但是同时又想继续公开基类的getter/setter,那么这个时候应将基类的属性名前加上“$”作为子类属性名,并且子类的属性名应该标志为final,且除了调用基类getter/setter外不应该做其它的事情:mx_internal final function get $numChildren():int{ return supernumChildren;} 13存储变量命名:getter/setter属性foo所存储的变量应该是_foo(加上下划线) 14控件ID:以控件类型缩写开头,如按钮类型的:btnSend,的:imgFeng等等。每个控件只要有id则id放在第一位,如<mx:HTML id="htmlBaidu"。 15声明:每行一个申明,分号结束,变量的申明放在开始位置,循环内部变量除外。 16行、换行、缩进、空格 每行不要 *** 过110个字符,即不要 *** 过可视化的部分,在逗号之后,运算符之前,较高级别代码处换行, 在后面的行缩进二个制表符(按两次Tab键) 同一父组件之间的子组件之间插入空白行,下一级组件与上一级组件缩进一个制表符 函数之间插入空白行,局部变量和申明之间换行,一段代码的逻辑之间换行,单行注释或特殊的多行注释之前换行 关键字与小括号之间空格,方法的形参逗号后面加空格, *** 作数之间插入空格(一元 *** 作符之间不要加入),方法名与括号之间、对象名和类型间不插空格。使用三元 *** 作符要用空格隔开,必要时可以拆分成多行 17注释 尽量为每个变量、类、函数、参数等编写注释一般每个文档前面都需要写注释,内容包括主要功能,作者,日期等等, /作者: 黄国龙

日期: 2008-10-31

功能:

修改记录:/ 函数注释示例:/函数名: ChangeName

作者: 001

日期: 2008-12-12

功能: 改变名称

参数:ID :名称id name:修该的名称

返回值: 类型(boolean)

返回true表示修改成功

返回false表示修改失败

修改记录:

/如果这个函数所在的文档有注释的话,则公用的部分可以可以不写,当然并不是每个函数都需这么写注释,根据具体情况而定。 变量注释:Var intCount:int=0 //计数器的值 18 表达式相关: 对于通用的 *** 作符(+, -, , /, &&, ||, <, <=, >, >=, ==, !=)不要使用不必要的圆括号;其它的优先级不容易记住的可以借助圆括号。 19 强制类型转换: 不要将Boolean变量和true或false比较;显式的将int,uint, Number, String转换为Boolean值,使用if(n !=0 )而不是if (n),使用if (s != null && s != “”)而不是if (s),对于对象引用来说可以隐式转换为Boolean值,使用if (child)而不是if (child != null),使用if (!child)而不是if (child != null);使用强制类型转换而不是as *** 作符,仅仅当强制转换可能失败并且你希望失败的时候值为null而不是抛出异常。使用IUIComponent(child)document而不是(child as UIComponnet)document; 20 比较:以更容易理解的方式书写比较表达式: if (n == 3) // "if n is 3"(Yes),if (3 == n) // "if 3 is n"(No); 21 ++和– *** 作:前缀形式和后缀形式效果一样的时候使用后缀形式,只有当你想在变量在 *** 作之前使用的时候才使用前缀形式; 22 三元 *** 作符:可以使用三元 *** 作符代替简单的if/else逻辑,尤其是对null进行判断的时候;return item itemlabel : null (Yes)if (! Item)return null;return itemlabel; (No)但是不要使用嵌套的三元 *** 作符; 23 new:即使构造的类不带参数也要使用圆括号:var b:Button = new Button();(yes)var b:Button = new Button;(No); 24 include:使用include而不是已废弃的#include,和前面一样,每个声明语句以分号结束;使用相对路径而不是绝对路径; 25 use namespace:避免使用,非公开名字空间引用使用“::”:Yes:import mxcoremx_internal; // Later, in some methodmx_internal::doSomething(); No:import mxcoremx_internal;use namespace mx_internal; // Later, in some methoddoSomething(); 26 if:当if/else分支只有一句声明的时候,不要用{}括起来;Yes:if (flag)doThing1();――――――――――――――――――――――――――――――――――――if (flag) doThing1();elsedoThing2():―――――――――――――――――――――――――――――――――――――No:if (flag){ doThing1();}――――――――――――――――――――――――――――――――――――― 27保留字、关键字l undefined尽量避免使用;l int和uint:整数后面不要加小数点,十六进制用0x开始,后面的字母大写;l RGB色通常用六个十六进制数字表示;l 索引值-1表示“没有索引项”;l Number:通常表示可以带小数,所以即使变量是整数也应该加上一个小数点和一个零,比如alphaFrom = 00; alphaTo = 10;但是屏幕坐标值不要这样做;l 指数计数的时候使用e,比如10e12,不要用大写E;l String:使用双引号界定字符,即使字符中间包含引号:字符what’up, “Big Boy”表示为"What's up, \"Big Boy\"",而不是’what\’s up “Big Boy”’;l Array:使用“[]”,而不是new Array(),比如[1, 2, 3]而不是new Array(1, 2, 3);这里在一个数组变量的时候容易出问题,比如一个包含一个值3的数组,如果用new Array(3),那么表示的是建立了一个三个元素的数组[undefined, undefined, undefined],而不是[3];l Object:使用{},而不是new Object();比如{}, {a: 1, b: 2, c: 3};l Function:避免使用匿名函数,用类方法或者包方法代替;如果一定要用,那么声明返回值,并且函数体内最后一个语句用分号结尾:function(i:int):void { doIt(i - 1); doIt(i + 1); }l RegExp:不要使用正则表达式构造函数创建正则表达式,使用var pattern:RegExp = /\d+/g;而不是var pattern:RegExp = new RegExp("\\d+", "g");l XML和XMLList:直接使用保留字声明,不要使用构造函数。使用var node:XML = <name first="Jane" last="Doe"/>;而不是var node:XML = new XML("<name first=\"Jane\" last=\"Doe\"/>"); XML属性值要使用双引号括起来,不要使用单引号。l Class:只有当需要在区分两个导入类的时候才使用类的全名,正确做法(Yes:):import mxcontrolsButton;var b:Button = new Button();错误做法(No:):import mxcontrolsButton;var b:Button = new mxcontrolsButton();正确做法:import mxcontrolsButton;import mycontrolsButton;var b:Button = new mxcontrolsButton();

1this总是指向函数的直接调用者(而非间接调用者);2如果有new关键字,this指向new出来的那个对象;3在事件中,this指向触发这个事件的对象,特殊的是,IE中的attachEvent中的this总是指向全局对象Window;

e是函数的参数,举个例子你就明白了

addEventListener(EventENTER_FRAME, function(e)

{

    // e实际上是Event实例

})

其实完整的写法应该是这样

addEventListener(EventENTER_FRAME, function(e:Event):void

{

    // e实际上是Event实例

})

使用了匿名函数和不定参数,所以看起来会有些困扰

欢迎分享,转载请注明来源:内存溢出

原文地址: http://outofmemory.cn/langs/12176527.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2023-05-21
下一篇 2023-05-21

发表评论

登录后才能评论

评论列表(0条)

保存