导入mycodetemplates.xml统一注释样式
下表描述了类和接口声明的各个部分以及它们出现的先后次序。
类/接口声明的各部分 |
注解 |
|
---|---|---|
1 |
类/接口文档注释(/**……*/) |
类的功能等信息 |
2 | 类的(静态)变量 |
首先是类的公共变量,随后是保护变量,再后是包一级别的变量(没有访问修饰符,access modifier),最后是私有变量。 |
3 | 实例变量 |
首先是公共级别的,随后是保护级别的,再后是包一级别的(没有访问修饰符),最后是私有级别的。 |
4 | 方法 |
这些方法应该按功能,而非作用域或访问权限,分组。例如,一个私有的类方法可以置于两个公有的实例方法之间。其目的是为了更便于阅读和理解代码。 |
5 | 构造器 |
变量声明
推荐一行一个声明,因为这样以利于写注释,使用制表符:对齐
int level; // indentation level int size; // size of table char username; // username
|
.java代码中不出现中文,最多注释中可以出现中文
采用反域名命名规则,全部使用小写字母。一级包名为com,二级包名为hbsi,三级包名根据应用进行命名,四级包名为模块名或层级名
例如:com.hbsi.education.activity
以[com].[hbsi].[项目名]. [组件].的方式命名:如下图 所示
com |
hbsi |
education |
activity |
common |
|||
adapter |
|||
service |
|||
parser |
|||
bean |
|||
utils |
|||
dao |
|||
manager |
|||
receiver |
采用大驼峰命名法,尽量避免缩写,除非该缩写是众所周知的, 比如HTML,URL,如果类名称中包含单词缩写,则单词缩写的每个字母均应大写。
继承自系统组件类的命名,后缀必须明确表示出系统组件的类
接口命名
采用大驼峰命名法,多以able或ible结尾,如interface Runna ble ;interface Accessible 。
动词或动名词,采用小驼峰命名法 例如:onCreate(),run()
需要注意的一点,所有的getter和setter方法都使用系统自动生成的方法生成。
采用小驼峰命名法。类中控件名称必须与xml布局id保持一致。
View变量命名:控件类型描述 + 意义描述
其中系统控件中在前缀中体现控件类型,比如tvName如下所示:
组件名称 |
前缀 | 组件名称 |
前缀 |
组件名称 |
前缀 |
---|---|---|---|---|---|
Button |
btn |
RadioButton |
Rb | RelativeLayout |
rl |
ImageButton |
ibtn |
TextView |
tv | LinearLayout |
ll |
ImageView |
iv | ListView |
lv | TableLayout |
tl |
ProgressBar |
pb |
EditText |
et | AbsoluteLayout |
al |
ScrollView |
sv |
CheckBox |
cb | FrameLayout |
fl |
注:绝对不允许出现,变量首字母大写和有下划线的情况出现,常量命名除外。
用统一的量词通过在结尾处放置一个量词,就可创建更加统一的变量,它们更容易理解,也更容易搜索。例如,请使用strCustomerFirst和strCustomerLast,而不要使用strFirstCustomer和strLastCustomer。
量词列表:量词后缀说明
资源的命名必须以全部单词小写,单词间以下划线分割并且使用名词或名词词组,即使用 模块名_功能名称 来命名,公共的资源使用 common_模块名_功能名称。
btn_login_normal |
按钮图片使用btn_功能_说明 |
bg_head |
背景图片使用bg_功能_说明 |
def_search_cell |
默认图片使用def_功能_说明 |
icon_more_help |
图标图片使用icon_功能_说明 |
seg_list_line |
具有分隔特征的图片使用seg_功能_说明 |
sel_ok |
选择图标使用sel_功能_说明 |
全部小写,采用下划线命名法,加前缀区分。
动画命名例子 |
规范写法 |
备注 |
click_head_left |
点击背景切换动画使用click前缀标识 |
|
bg_shape_rectangle |
背景自定义图形使用bg前缀标识 |
|
show_shopcar_add |
小动画效果使用show前缀标识 |
|
大小写规范与方法名一致,采用小驼峰命名法。命名规范为“资源控件的缩写
注意:页面控件名称应该和控件id名保持一致
命名模式:
activity名称_功能模块名称_逻辑名称
activity名称_逻辑名称/common_逻辑名称
strings.xml中,使用activity名称注释,将文件内容区分开来
命名模式:activity名称_逻辑名称/common_逻辑名称
原文地址:http://blog.csdn.net/zhaoyazhi2129/article/details/40108109