`
- 浏览:
17949 次
- 性别:
- 来自:
广州
-
此文转载于网上
一,基本原则
- 约定大于配置,约定大于规范
- 规范思想,并非为束缚手脚
- 在无歧义的前提下,命名力求简洁
- 在语义明了的前提下,命名力求省力,如果可以同时不按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
相关推荐
阿里巴巴编码规范AS工具插件是Java开发者遵循高质量编程标准的重要辅助工具。该插件名为"Alibaba Java Coding Guidelines",版本为1.0.5,旨在帮助开发人员在使用IntelliJ IDEA或Android Studio等集成开发环境(IDE...
在Flex与AS3的编程环境中,遵循一套统一的编码规范对于提高代码的可读性和可维护性至关重要。以下将详细介绍Flex + AS3编程规范中涉及的关键知识点,包括缩写规则、文件命名、包与命名空间管理、接口与常量命名、...
《C#通用编码规范》是GDTEC公司为新员工培训和技术部门制定的一份详尽的编程指导文档,旨在提高代码质量和团队协作效率。本文档主要涵盖了注释规范、.NET编码规范和数据库编码规范等多个方面,以下是这些规范的详细...
C#编码规范是编程实践中非常重要的一个环节,它有助于提高代码的可读性、可维护性和团队间的协作效率。以下是对这些规范的详细说明: **一、类型级单位的命名** 1. **类(Class)**:类的命名应当以名词或名词短语...
### SQL高性能编码规范详解 #### 一、引言 在软件开发过程中,SQL作为数据库查询语言,被广泛应用于数据检索和处理。为了提高SQL代码的性能及可读性,制定一套标准化的编码规范至关重要。本文将详细介绍《SQL高...
在开发Flex项目时,遵循一套编码规范至关重要,这有助于提高代码的可读性、可维护性和团队协作效率。以下是关于“Adobe Flex 编码规范”的详细解读: 1. **命名规范**: - 变量和函数名应使用下划线分隔的驼峰式...
### DotNet项目编码规范 #### 一、程序代码的注释 **1. 存储过程的头部注释** 在DotNet项目中,为确保代码的可读性和维护性,每个存储过程都应当包含头部注释。这些注释通常位于存储过程的最前面,包含了重要的元...
### JAVA编码规范全集 #### 1. 介绍 ##### 1.1 为什么要有编码规范 编码规范在软件开发过程中扮演着至关重要的角色。它不仅有助于提高代码的可读性和可维护性,还能增强团队协作效率。以下是几个关键理由: - **...
**DELPHI真正的编码规范** Delphi是一种强大的Object Pascal编程语言,它以其高效、灵活性和丰富的组件库而受到开发者的喜爱。为了确保代码的可读性、可维护性和团队协作的有效性,遵循一定的编码规范至关重要。...
VB(Visual Basic)编码规范是为了提高代码的可读性、可维护性和团队协作效率而设定的一系列编程标准。以下是对VB编码规范的一些关键点的详细解释: 1. **IDE设置**: - **要求变量声明**:开启此选项,确保在编写...
### Go编码规范详解 #### 一、命名规范 在Go语言开发中,良好的命名习惯能够显著提高代码的可读性和可维护性。 ##### 1.1 文件名命名规范 - **命名方式**:文件名应使用小写字母,并且尽可能直观地反映出文件中...
### Python编码规范详解 #### 背景介绍 Python作为一种广泛应用的高级编程语言,在软件开发、数据科学、网络爬虫等多个领域发挥着重要作用。为了提高代码的可读性、可维护性和一致性,遵循一定的编码规范变得尤为...
VB.NET编码规范是软件开发中的一个重要环节,它确保了代码的可读性、可维护性和团队协作的高效性。以下是对这些规范的详细解释: 1. **工程**: 工程组织应清晰,每个项目应有明确的功能划分。避免在一个项目中...
AS3是面向对象的编程语言,基于ECMAScript 4规范,具有类、包、接口等特性。创建自定义控件时,我们通常会定义一个类,这个类继承自已有的UIComponent或DisplayObject类,以便利用它们提供的基本绘图和事件处理功能...
在 Scala 编程中,遵循一定的编码规范可以提高代码质量和团队协作效率。以下是对给定的 Scala 编码规范的详细解释: **格式与命名** 1. **代码格式**:保持良好的代码格式至关重要。使用两个空格进行缩进,避免...
3. 编码规范: - 命名规则:变量、函数和类的命名应遵循驼峰式命名法,避免使用保留字。 - 注释:良好的注释可以提高代码可读性,注释应简洁明了,描述功能和用途。 - 代码结构:使用适当的缩进、空行和空格,...