Research 小组编码命名规范

 

Research 小组编码命名规范

目录

致组员... 1

类文件命名... 2

重要命名... 2

变量命名... 3

 

 

 

致组员

         这里是一个对于Research项目的命名规范阐述文档，希望大家对此命名规范进行及时的补充以及更新。

         在这里希望大家今后一定严格按照此编码规范进行编码，包括现在已经存在的代码，大家要在力所能及的情况下进行及时的更新以及整理，这将对Research项目今后的制作以及更新起到非常重要且非常良好的作用。

        

         这里为大家提供几点对于修改代码的思路

1.       针对类文件的命名，大家可以使用类的重构功能 (Refactor中的Rename选项)

这样Flex的编译工具可以自动对项目所有使用到该类的地方进行修正，方便大家修改。

2.       对于重要命名中提到的，大家可以从小范围慢慢的扩大进行修改，一定要确保命名修改后不影响原有的功能，特别是不能引起异常。

3.       对于变量命名，要略后于重要命名，因为重要命名中的规范将牵扯到整个项目的结构，并且对项目结构起着较重要的作用。而变量命名主要是方便组内或者新人来阅读大家的代码，这点对于项目进度也有着很直接的影响，所以虽然略后，也希望能引起大家的重视。

4.       在命名规范中，所有名称一律使用英文，不要使用拼音或简易拼写，有一些是需要根据当前变量或控件的作用定义的名称，如果不清楚怎么写的可以问组长或者尹键楠，但是千万不要凑合，因为谢第一次时凑合，后面改起来会更麻烦，希望大家理解。

 

注：对于已有命名的修改是很重的一项工作，并且不能求急，大家可以每天做一点，但一定要确保不能因修改代码而造成原有项目出现问题。

 

致！

 

 

 

 

 

类文件命名

类文件在项目中的用途不是很广，现在大多数用于封装Bean (属性) 和Method(方法)

Bean类一般都是针对数据库表进行封装的，所以请大家命名如下：

针对数据库表的封装，可以使用表的名称 + Bean

例如：针对 Plants 表封装的 Bean 可以叫做 PlantsBean

还有一些特殊的是对所有 ArrayCollection 进行封装的 Bean ，可以叫做 ArrayCollectionBean ，

注：因为一个模块一般只存在一个这样的 Bean ，所以我们没有必要使用其它的名称，一般用这个就可以了

 

Method类是对于某张表或某个模块相关的数据库交互方法进行封装，命名如下：

针对表的封装，可以使用相关表或模块的名称 + Method

例如：针对 Areas 表，可以写成 AreasMethod

或者针对某个模块，可以写成模块的功能或名称 + Method

    例如： AreasMethod (Areas 这一模块中所涉及的方法 )

          CheckExistIdMethod ( 检查现有 ID 用的方法 )

重要命名

         对于这里以下的命名，大家可以参考IIR提供给大家的命名规范，那个十分详细，这里我把其中一些常用，并且实际用处的较多的给大家列出，如下：

1.       数据库字段名

每个单词首字母大写，如果出现一个以上单词，以下划线分隔开

示例：     Company

Company_Product

Company_Product_Attribute

2.       文件名

每个单词首字母大写

示例：       Login.mxml

如有特殊用途，在最前以关键字标明

示例：       RendererOnsite.mxml ( 关键字 Renderer 代表 ItemRenderer , Onsite 是名称 )

3.       文件夹

每个单词首字母大写

示例：       Components

                    RendererComponents ( 一个用于放置 ItemRenderer 控件的文件夹 )

4.       事件相关

关于系统事件，大家只需要使用 event 关键字

示例：       event:Event ( 任何事件都可以这样来写 )

event:MouseEvent ( 或者可以特指某一种事件 )

关于自定义事件，最好以当前事件的作用来定义当前事件的名称

示例：      dispatchEvent(new Event(“DataLoadCompleted”))

数据加载完毕时派发的事件

变量命名

         下面是一些常用的变量以及控件命名 ( 格式：控件或变量类型 : 命名前缀 )

         Array: a

ArrayCollection: ac

Button: btn

ButtonBar: bar

Boolean: b

ControlBar: bar

CheckBox: cbx

ComboBox: cmb

Canvas: cvs

DateField: date

DateChooser: date

Date: date

DataGrid: dg

DataGridColumn: dgc

Error: err

HBox: box

htmlText: txt

Image: img

Int: i

Label: lbl

List: lst

LinkButton: btn

LinkBar: bar

MenuBar: bar

Number: f

Object: obj

ProgressBar: pb

Panel: pnl

QiAgent: qi

String: s

Tree: tr

TitleWindow: win

Text: txt

TextArea: txt

TextInput: txt

Timer: t

VBox: box

Effert:ef  ( 所有的特效，无论类型，都使用此命名前缀 )

 

注：命名前缀一律使用小写字母，前缀后紧跟变量或控件名称，所有名称最好以当前变量或控件的作用来定义当前变量的名称