关于规范,看了一些资料,貌似也用不着那么多约束,只是把感觉有用的一些地方整理了一下,包括代码的书写规范,目前项目工程结构。
一、 目录规范
1、 目录文件命名:
包:采用驼峰式命名,第一部分使用顶级域(如com.)
示例:com.flex.sampleone.moudle
文件:(1)命名中不能包含空格、标点和特殊符号
(2)类和接口使用开头字母大写的驼峰式命名,接口前多加一个“I”
(3)MXML:开头字母大写的驼峰式命名
(4)CSS:开头字母小写的驼峰式命名
2、 工程文件有序分类存放。
Flex端的文件(.mxml/.as)放在flex_src文件夹中,并用包分类;
Java端的文件(.java/.xml等相关配置文件)放在src文件夹下,并构建合理的文件结构;
外部导入的库文件放在flex_libs文件夹下;
外部导入的媒体图片等资源新建文件夹放在工程目录src文件夹下。
二、 命名规范
首要一点:要具有一定的实际意义,提高程序的可读性,保证其他编程人员能够很快理解。
1、类及类成员:
类的命名开头用大写,
本工程中JAVA类的命名:
(1)action中写的类名为:Pm[自定义]Action;
(2) DAO中写的接口类名为:Pm[自定义]DAO,函数实体类名为:Pm[自定义]DAOImpl;
(3)model中写的是原型类名为:Pm[自定义]。
类成员均采用的是驼峰式命名。
2、函数和变量:
方法和变量的名称应该以小写字母开头,除非必要,忌在其中掺杂数字;
临时变量通常只用一个字母;
3、 消息响应函数:[触发消息响应函数的方法名]Handler
4、 常量:全部用大写字母,单词之间用下划线
三、 编码规范
1、 格式
换行:(1) 逗号后,运算符之前
(2) 换行后应与上一行对齐
声明:(1) 每行一个声明
(2) 尽量对变量初始化(除在方法调用中传值的变量)
空格:关键字和小括号之间插入空格(方法和他相应的括号之间不要加空格)
赋值号和比较符号与其他字符间插入空格。例:a = a + 1;
2、 缩排
(1) 按回车提示的自动缩排。相对应的大括号在竖线方向位置对应。
(2) 若语句太长要换行,则下一行要缩进与上一行代码保持对齐。
四、 注释规范
1、文件注释:
文件开头的注释模板 ,要放在script中。
/**
* 文件名:
* 创建人:
* 日期:
* 功能描述:
* 可以设定的变量说明:
*
**/
2、类注释
3、成员注释(成员变量、成员函数)
函数注释:
/**
** 函数名:
** 功能描述:
** 参数变量说明
**/
4、关键语句注释
采用单选注释,用在变量定义以及某些特别需要说明的地方。如:
//用于传递主窗体中的数据
public var licenFmtObj:Object;