/**
* 本文档的制定为了使应用开发更清晰,以实际开发中加以完善此文档所作规范。
* @author haxido
* @date 2011-5-18
* @version 1.0.0
*/
一、项目目录结构说明
1.src存放源代码文件
2.assets存放流文件
3.doc存放文档文件
4.res/drawable-large存放480*800分辨率资源图片
5.res/drawable-mdpi存放320*480分辨率资源图片
6.res/layout-large存放480*800分辨率布局文件
7.res/layout-mdpi存放320*480分辨率布局文件
8.res/raw存放媒体文件
9.values/保存字符串资源等
10.gen中为项目自动生成文件
11.AndroidManifest.xml配置文件
二、文件命名规范
1.代码文件命名规范
a.一般的代码文件命名以继承名类名为前缀,例:继承自Activity的文件可写成ActivityMain.java。
b.一些纯粹的类名命名遵守以大的归类为前缀,可自定,如InfoRank.java。
c.首字母及新单词开始必须大小写,遵从匈牙利命名法则(前缀+修饰语)。
2.图片资源文件命名命名规范
a.命名以全小写,单词不缩写。
b.图片的命名必须唯一,整套图片直接存放于drawable文件夹下,以命名分类。
c.按钮类图片命名以button为前缀,如buttonok,buttoncancel。
d.背景类图片命名以back为前缀。
e.显示类图片命名以view为前缀。
f.展示类图片命名以dis为前缀,如幻灯片播放。
g.临时用图命名以tmp为前缀。
h.其他图上命名以other为前缀。
3.布局文件命名规范
a.命名以全小写,单词不缩写。
b.布局文件的命名可参照代码文件的命名,一般来说一个页面一个xml,对应也会有一个java代码,对应的java和
xml命名可相同。
c.对于一些属性文件命名以css为前缀。
4.字符串命名规范
a.字符串命名采用全小写,下划线作为分隔符。
b.应用名字以app_为前缀。
c.网址以url_为前缀。
d.文字说明或参照内容以string_为前缀。
e.颜色以color_为前缀。
f.密码文字password_为前缀。
g.全数字以digit_为前缀。
5.包的建立规范
a.com.smarch为根目录,此目录只允许建立文件夹,不直接存放具体文件。
三、代码书写要点规范
1.xml中控件命名规范
a.命名遵守骆驼法则,即首字母小写。
b.命名在整个项目中必须唯一,以xml文件名 + 控件类型为前缀,如对activityclickme.xml中的一个Button命名,
可以写成如下形式activityclickmeButtonClose这种方式会显得文件名较长,但能保证唯一,还有一种做法,可
去掉xml文件前缀,上面的名字可写成如下clickmeButtonClose,建议采用第二种方法,比较清晰。
2.java代码中控件命名规范
a.以控件类型缩写名为前缀的方式,如TextView类型的控件可命名成tvShow, Button类型的控件可命名成btnOK等。