Android开发参考规范0.4

发表于

Android开发参考规范0.4(仅供参考,根据实际情况和个人习惯可以自定义)

 

1、项目框架 3

1.1 包名命名 3

1.2 资源规范 4

1.3 尺寸规范 6

2、代码规范 6

2.1 代码注释 6

2.2 方法名和变量命名规范 7

2.3 常量命名规范 7

2.4 代码风格 8

2.5 编码规范 8

2.6 其他 8

3、发布规范 8

3.1 签名规范 8

3.2 版本号规范 9

3.3 SVN及分配规范 9

 

 

 

 

 

 

 

 

 

 

 

 

 

1、项目框架

1.1 包名命名

 

adapter 适配器相关

base 通用父类

entity 实体类

constant 常量

lhqz 表示灵狐圈子模块(其他类似),每个大的模块

lib 表示放置可移植库

receiver 广播接收器相关

service 后台Service相关类

tools 常用工具类

view 自定义view相关

db 数据库相关

net 网络接口请求相关

third 代表第三方相关

 

说明:

一个唯一包名的前缀总是全部小写的ASCII 字母并且是一个顶级域名,通常是com,edu,gov,mil,net,org。后面跟有项目名称(或者缩写),再后面为模块名或层级名称。

如:com.linghoo.项目缩写.模块名  com.linghoo.lhsq.view

如:com.linghoo.项目缩写.层级名  com.linghoo.lhsq.activities

 

1.2 资源规范

 

res资源文件:

anim  动画相关配置

color 颜色相关配置

drawable 自定义drawable配置

values 中 styles.xml放置主题

备注(其他特殊情况,不一定按照这种情况处理,可扩展)

 

 

 

 

Layout布局文件命名规则:

Activity布局:activity_lhqz.xml (代表灵狐圈子Activity布局)

Fragment布局:fragment_lhqz.xml

item布局:item_lhqz.xml

通用包含类布局:include_lhqz.xml

其他view的布局: view_lhqz.xml

 

通用颜色色调命名:

通用颜色放置在color下,颜色名字按照色调命名:

red表示红色。

图片统一放在drawable-hdpi文件夹:(部分特殊图片除外)

 

图片资源命名规则:

图标类:icon_xx(后缀为拼音形式 icon_lhqz

背景类: bg_xxx  

 

drawable文件命名规范:

通用布局以global开头:global_title;

背景以bg开头:bg_lhqz;

selectorselector开头:selector_btn_zc.xml 表示注册按钮selector

normalpressednomal_xxx.xmlpressed_xxx.xml类似命名其他,如Button,TextViewImageView等按照btn_xxx.xmltv_xxx.xmliv_xxx.xml命名。

 

通用绘制完毕,可放置在excel文档里参考查阅

 

1.3 尺寸规范

 

文字尺寸用sp;布局尺寸用dp;文字大小建议使用双数,例如:12sp/14sp/16sp/18sp; 通用尺寸可放置在dimens.xml里(到时可以把最后统一的放置在excel文档里查询)

 

 

 

2、代码规范

 

2.1 代码注释

 

实体类建议每个属性都加个注释说明。

每个Activity顶部加入作者和时间注释。

其中列出类名、版本信息、日期和版权声明。

如下:

/*

* 文件名

* 包含类名列表

* 版本信息,版本号

* 创建日期。

* 版权声明

*/

 

常用的和关键的方法需要写明入参和返回值备注。

 

2.2 方法名和变量命名规范

 

方法命名:

命名规则:方法名是一个动词,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。

例如:

public void run();

public String getBookName();

 

类中常用方法的命名:

1.类的获取方法(一般具有返回值)一般要求在被访问的字段名前加上get,如

getFirstName(),getLastName()。一般来说,get前缀方法返回的是单个值,find前缀的方法返回的是列表值。

2.类的设置方法(一般返回类型为void):被访问字段名的前面加上前缀 set,如

setFirstName(),setLastName().

3.类的布尔型的判断方法一般要求方法名使用单词 is或has 做前缀,如isPersistent(),isString()。或者使用具有逻辑意义的单词,例如equal 或equals。

4.类的普通方法一般采用完整的英文描述说明成员方法功能,第一个单词尽可能采用动词,首字母小写,如openFile(),addCount()。

构造方法应该用递增的方式写。(参数多的写在后面)。

 

变量命名:

命名规则:第一个单词的首字母小写,其后单词的首字母大写。变量名不应以下划线或美元符号开头,尽管这在语法上是允许的。变量名应简短且富于描述。变量名的选用应该易于记忆,即,能够指出其用途。尽量避免单个字符的变量名,除非是一次性的临时变量。临时变量通常被取名为 i,j,k,m 和 n,它们一般用于整型;c,d,e,它们一般用于字符型。

例如:String bookName;

 

规约:变量命名也必须使用驼峰规则,但是首字母必须小写,变量名尽可能的使用名词或名词词组。同样要求简单易懂,不允许出现无意义的单词。

如:String bookName;  正确

如:String bookNameString; 错误!

 

2.3 常量命名规范

 

命名规则:类常量的声明,应该全部大写,单词间用下划线隔开。

例如:static final int MIN_WIDTH = 4; 

例如:static final int MAX_WIDTH = 999; 

例如:static final int GET_THE_CPU = 1; 

 

2.4 代码风格

 

1.缩进

规约:不允许使用Tab进行缩进,使用空格进行缩进,推荐缩进为2空格。

2.空行

空行将逻辑相关的代码段分隔开,以提高可读性。

下列情况应该总是使用空行:

l一个源文件的两个片段(section)之间

l类声明和接口声明之间

l两个方法之间

l方法内的局部变量和方法的第一条语句之间

l一个方法内的两个逻辑段之间,用以提高可读性。

 

规约:通常在 变量声明区域之后要用空行分隔,常量声明区域之后要有空行 分隔,方法声明之前要有空行分隔。

3.行宽

无特别规定,因为现在的显示器都比较大,所以推荐使用120进行设置。

 

2.5 编码规范

 

采用UTF-8编码,不推荐GBK编码,便于兼容。

 

2.6 其他

 

单击事件尽量单独提出来处理,不要嵌入太深的层次。

部分通用方法可以提取成为类放置在tools包下。稍微写下方法备注。

onCreate里尽量少放置代码,都提取成方法。

逻辑嵌套不要超过3,这样扩展和修改也逻辑清晰,别人可以看懂。开发效率也会提升。

采用父类和全局控制机制。例如日志输出可以采用开关模式,正式和测试服务器切换采用枚举方式方便切换。合理的使用广播机制。

要处理网络请求主要情况下会出现的问题,如成功和失败情况下。

 

3、发布规范

3.1 签名规范

 

APK发布前,需要进行密钥签名,密钥日期推荐设置1000年有效期。将生成的密钥放置到项目根目录。便于成员更新和签名使用。

 

 

 

 

 

3.2 版本号规范

 

发布版本要确认VersionNameVersionCode都已经正确写好或者升级+1VersionName采用0.0.0.0  4位控制。

涉及到数据库升级时,确认是否需要数据库升级。

 

3.3 SVN及分配规范

 

SVN要及时更新和提交,提交加入备注。

任务分配避免重合,每个人做最擅长的模块。

 


文章评论
共收到 0 条评论