`
- 浏览:
17311 次
- 性别:
- 来自:
广州
-
此文转载于网上
一,基本原则
- 约定大于配置,约定大于规范
- 规范思想,并非为束缚手脚
- 在无歧义的前提下,命名力求简洁
- 在语义明了的前提下,命名力求省力,如果可以同时不按shift,则不按
- 命名=表义词语+类型,名称表义为先
- 坚持使用强类型
- 把常用的成员,放在容易找到的地方,给予它们更大的访问权限
- 源码格式以清晰易读为准
- 写注释优先极大于写代码
二,一般规则
- 文件组织结构与包(在MVCS开发模式下)
范式:(companyDomain|teamName).projectName
+controllers 控制器目录
+events 事件目录
+managers 管理器目录
+models 数据模型目录
+models.vos VO对象目录
+services 数据服务目录
+views 视图目录
+views.uis UI目录
+utils 工具类目录
+Module_{Name}.as 模块类(IFacade)
说明:|表示或者,两者取其一
词性:名词
命名:驼峰命名法,第一个单词首字母小写,第二个单词首字母大宇,因形似驼峰而得名
- 类与类文件
范式:SealedName[Type]
说明:若无歧义,[]之内可略去,以下同
如PopUpManager、MouseEvent、StringUtil、FishController等
在MVC开发模式下,如果去掉Type,在项目中则可能出现同名文件,虽然完全限定名不同,但同时在同一个类中被引入时,会给编码带来不便。在这种情况下,保留Type更为合理。
词性:名词
命名:大驼峰命名法(首单词首字母大写)
- 接口
范式:ISealedName[Type]
说明:接口与类相比,不同之处仅在于附有前缀I
词性:字母I+名词
命名:大驼峰命名法(首单词首字母大写)
- 常量
范式:CONST_VARIABLE_NAME = “constVariableName”
命名:常量名称单词大宇,间以下划线,常量值使用驼峰命名法
词性:名词、动名词等
用途:在事件类中定义事件类型,在枚举类中定义枚举值等
- 实例变量、参数变量、函数变量与类静态变量
范式:variableName
命名:驼峰命名法
- 函数
范式:[varName_]getMethodName(argName1 :String…)
命名:驼峰命名法
词性:动词、动名词
- 命名空间
范式:lib_internal
命名:小写字母单词,间以下划线
词性:名词+形容词
- 类成员的位置
成员优先级从高到低:常量,静态变量,静态函数,构造器,实例变量,getter/setter属性存取器,函数
同级别的成员按访问修饰符排序:public,internal,protected,private
三,具体细则
- 在参数变量、函数变量中常用的缩写
c : Controller(或ctrl)
m: Model
v:View
e : Event or Error
mdl: Module
ui: UI
srv: Service
btn:Button
mc:MovieClip
spt:Sprite
- 在MVCS开发模式下,常用的Type后缀
视图:View
视图接口:IView
控制器:Controller
数据模型:Model
数据对象:VO
UI:UI
管理器:Manager
事件集:Events
事件:Event
常量:s
数据服务:Service
工具类:Util
模块:Module
- 事件句柄函数命名举例
onClick(e :MouseEvent) :void
btnClose_onClick(e:MouseEvent) :void
mouseEventHandler(e :MouseEvent) :void
mcName_mouseEventHandler(e :MouseEvent) :void
- 颜色变量使用uint
- 时间变量使用Number
- switch多在事件句柄函数中使用
- 优先使用Vector,在声明数组Array时,标明它的元素类型,如fishs : Array /* Element Of Fish */
- 避免使用try..catch
- 在for循环中,使用j、k、m、n作为循环数字
- 不要声明没有类型的变量,不要使用*使用类型修饰符,避免返回类型为Object的对象
- 不用使用Object作为HashMap,使用Dictionary代替
- 基本弃用private,默认非公开的实例变量与实例函数使用protected访问修饰符
- 在VO类中,默认所有变量使用基元类型作为类型修饰符,使用public作为访问修饰符
- 基本弃用getter/setter,在一般情况下,不使用public的getter/setter存取器,代替以public getMethod/setMethod。
- 把花括号放在同一列,如:
public getMehtod() : void
{
}
- 在类、函数上使用ASDoc注释,如:
/**
* comment
*/
- 不使用下划线作为变量前缀。
- 以Flash制作资源文件时:
元件成员分层放置,每层须有名称
库元件分目录放置,以类别组织文件夹
元件的实例名称使用驼峰命名法,命名规则与实例变量同
元件的导出名称与所要绑定的类名一致
Label与AS均单独放在一层里,置于最上面
避免使用mask
尽量不要使用滤镜
- 控制显示对象的位置时,避免使用小数
- 修改fla文件之前要签出、锁定,再修改。
- 使用空白字符使代码明晰易读,如:
在单词、符号之间使用空格
在函数、变量之间使用空行
在包、类、函数、匿名函数各级别间使用缩进
如果参数列表过长,或数组元素很多,可以拆行,使用相同缩进
- 在导入类时,避免使用*号
- 约定在注释中添加fixed标签的类或函数,不要随意更改
- 函数变量在函数顶部统一声明,在事件函数内部移除事件监听统一放在最上面
分享到:
Global site tag (gtag.js) - Google Analytics
相关推荐
压缩包包含: 1、阿里巴巴编码规范插件Alibaba Java Coding Guidelines-1.0.5.zip 2、使用说明, 最新插件下载官网 3、插件源码
Adobe Flex 编码规范 AS ActionScipt Flash 中文 文档
在软件工程领域,源程序的风格统一标志着可读性、可维护性、可重用性,是软件项目的一个重要组成部分。本文档参考了网上的一些资料,结合自己的开发,整理了一份AS3.0的编码规范。希望对大家有用。
android 开发统一团队内部的编码规范和习惯,偏向于强制申明。
android编码规范 可在as里面配置File-->Settings->Editor->Code Style,配置编码规范,还需要安装code style插件。
谷歌C++编码规范。 C++ is the main development language used by many of Google's open-source projects. As every C++ programmer knows, the language has many powerful features, but this power brings with...
博文链接:https://hereson.iteye.com/blog/190878
As every C++ programmer knows, the language has many powerful features, but this power brings with it complexity, which in turn can make code more bug-prone and harder to read and maintain.
3 命名规范 4 代码样式规范 5 资源文件规范 6 版本统一规范 7 第三方库规范 8 注释规范 9 测试规范 10 其他的一些规范 1 前言 为了有利于项目维护、增强代码可读性、提升 Code Review 效率以及规范团队安卓开发,故...
3、符号 1) 大括号 与语句放同一行,放于最后面;仅有一行语句,也使用大括号: if (true) { //true } else { //false } while (true) { //alert(1); } 2) 空格 在逗号、分号、冒号后加空格 在操作符...
as3-msgpack v1.0.1 as3-msgpack是针对Actionscript3语言(Flash,Flex和AIR)的MessagePack规范的实现。 入门: : 下载最新版本: : 请参阅在线文档: : 检查愿望清单: : 关于消息包格式MessagePack是一种有效的...
设置文件编码格式为UTF-8 显示空格和行号,并使用空格缩进 行长度 Tab缩进 5)禁用AS的更新
ID and class naming ID和class(类)名总是使用可以反应元素目的和用途的名称,或其他通用名称。代替表象和晦涩难懂的名称。 应该首选具体和反映元素目的的名称,因为这些是最可以理解的,而且发生变化的可能性最小...
实验室认可规范文件清单。CNAS实验室认正可以参考。。。
windows声音应用程序开发指南 电子课件 PPT 本书介绍了Windows环境下进行音频(声音)程序设计的原理和方法。...第3章介绍了Microsoft的ASF及其技术核心;第4章分析了MP3文件的基本结构和MP3编码器。
Google的Java编码规范 This document serves as the complete definition of Google's coding standards for source code in the Java™ Programming Language. A Java source file is described as being in Google...
规范了一些错误信息,参考winerror.h -- error code definitions for the Win32 API functions 删除SendData和RecvData方法 by itas109 on 2016-08-10 http://blog.csdn.net/itas109 https://github.com/itas109 ...