Android --- 命名规范
一、命名规范
1、 包
采用反域名命名规则,全部使用小写字母。一级包名为com,二级包名xxx(为个人或公司名称,可以简写),三级包名根据应用进行命名,四级包名utils或service等(模块名或层级名),根据实际情况也是可以用五级包名,六级包名。
utils
此包中包含:公共工具方法类,比如:LogUtil、TimeUitl、FileUtil等
adapter
此包中包含一些适配器的类,比如:CardAdapter、FloatWindowAdapter等
base
此包中包含:一些共同类的基类,比如:BaseActivity(所有的Activity类都继承这个类)、BaseFragment(所有的Fragment都继承这个类)
bean
此包中包含:一些属性对象类,比如:StudentBean、UserBean等
config
此包中包含:最顶级的配置类,比如:MyApplication(继承了Application)
httpservice
此包中包含:Http数据的请求接口类,如:ILogin接口,IRegister,IUpdate等
interface
此包中包含:某个页面或对象的所用操作接口类,这个接口主要是定义这个对象的所有方法。如:IUser接口,IArticle接口,ITopic接口等
model
这是MVC或MVP框架设计中的M。此包中包含:某个页面或对象的所用操作类,这个类继承了上面定义的interface接口,重写并实现方法。如:UserModel,lLoginMode类
view
此包中包含:activity包。如MainActivity,HomeActivity.
fragment包。但是Fragment一般都是多个存在的,所以fragment包下一般还有六级包名,表示里面是哪个页面的Fragment对象。
weight
此包中包含:自定义View或自定义对话框等视图类。如:CursroDialog类,ScrollListView类等
db
此包中包含:数据库操作类
service
此包中包含:Service服务类
broadcast
此包中包含:Broadcast广播接收者类
provider
此包中包含:Provider内容提供者类
2、 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写。
如:public class MyFirstClass{}
3、 变量名、方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写。
如:int index=0;
public void toString(){}
isXX() checkXX()方法返回值为boolean型的请使用is或check为前缀标识
getXX(),返回某个值的方法,使用get为前缀标识
4、 常量名全部大写
private static final String DEFAULT_VALUE = null;
6、所有命名规则必须遵循以下规则:
1)、名称只能由字母、数字、下划线、$符号组成
2)、不能以数字开头
3)、名称不能使用JAVA中的关键字。
4)、坚决不允许出现中文及拼音命名。
5)、程序中使用单词缩写原则:不要用缩写,除非该缩写是约定俗成的。
下面为常见的英文单词缩写:
名称缩写
icon ic (主要用在app的图标)
color cl(主要用于颜色值)
divider di(主要用于分隔线,不仅包括Listview中的divider,还包括普通布局中的线)
selector sl(主要用于某一view多种状态,不仅包括Listview中的selector,还包括按钮的selector)sel_ok 选择图标使用sel_功能_说明
average avg
background bg(主要用于布局和子布局的背景)
bg_head 背景图片使用bg_功能_说明
buffer buf
control ctrl
delete del
document doc
dialog dlg_hint.xml
error err
escape esc
increment inc
infomation info
initial init
image img
Internationalization I18N
length len
library lib
message msg
password pwd
position pos
popupWindow ppw_info.xml
server srv
string str
temp tmp
window wnd(win)
button btn_xx
btn_xx_normal 按钮图片使用btn_正常情况效果
btn_xx_press 按钮图片使用btn_点击时候效果
LayoutView lv
RelativeView rv
TextView tv
Button btn
ImageButton imgBtn
ImageView imgView 或 iv
EditText edtTxt
Tab tab
Spinner spn
Chronometer cmt
ScollView sclVi
TextSwitch txtSwt
ImageSwitch imgSwt
listView lVi 或则lv
ExpandableList epdLt
MapView mapVi
二、注释规范
1、类注释
在每个类前面必须加上类注释,注释模板如下:
/**
* Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.
* FileName: Test.java
* 类的详细说明
*
* @author 类创建者姓名
* @Date 创建日期
* @version 1.00
*/
2、属性注释
在每个属性前面必须加上属性注释,注释模板如下:
/** 提示信息 */
private String strMsg = null;
3、方法注释
在每个方法前面必须加上方法注释,注释模板如下:
/**
* 类方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @return 返回结果的说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/
4、构造方法注释
在每个构造方法前面必须加上注释,注释模板如下:
/**
* 构造方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/
5、方法内部注释
在方法内部使用单行或者多行注释,该注释根据实际情况添加。
如://背景颜色
Color bgColor = Color.RED
http://www.taodudu.cc/news/show-511620.html
相关文章:
- Android --- 新版本取色器吸管工具点击无效,没反应
- Git 报错 Push to origin/master was rejected
- idea 中 git 修改了文件却无法提交(No Changes detected)
- Android --- 拍照上传图片之后,发现图片是全黑色,什么内容也没有
- Android --- TabLayout 切换时,改变选项卡下字体的状态(大小、加粗、默认被选中第一个)
- Android --- Android Device Monitor 在 3.0 版本之后废弃了怎么办
- Android --- 百度地图 SDK v3.6.0 以上版本找不到 PoiOverlay 类
- 数据库创建表的时候长度的介绍
- JPA 一对一设置无效,连表查询的时候另外一个实体类的对象值为空
- Android --- 怎么设置 EditText 控件中光标默认位置,当 EditText 里有文字的时候,光标跑到了最前面
- Android --- GridLayoutManager 设置了 item 均匀分布,但是无效
- Android——Spinner 怎么禁止下拉框下拉
- Android --- 刚刚进入 Activity 页面的时候无法打开对话框,报错 Unable to add window -- token null is not valid; is your
- Android --- TabHost 切换时,改变选项卡下字体的状态(大小、加粗、默认被选中第一个)
- Android --- 两种设置字体加粗的方法
- Android --- 选项卡背景样式,左侧边有颜色
- Android --- RecycleView获取第 i 个 item 里面的控件并进行赋值
- Android --- RecycleView 中默认选择第一个 item,点击第 2 个 item 时改变其字体样式,其余的 item 的字体样式恢复默认
- Android --- RecyclerView 水平滑动时,一个 item 一个 item 的滑动,禁止滑动到一半停止
- 【阿里云域名】我都有服务器了,为什么还要购买域名?
- Android --- 单一控件覆盖其他控件的方法
- Android—— ScrollView 与 ListView 滑动冲突处理
- Android——TabLayout 默认某个选项卡选中
- Android --- 数据库存储的是正确的时间格式(2021-06-17 21:47:23)但是在获取的时候变成了(2021-06-17T13:47:23.000+00:00)
- Android --- 如何更改应用程序的图标以及名称(Android studio)
- Android --- ListView之高度由 item 的个数决定,wrap_content有效
- Android --- 很好用的时间选择器
- Android --- 当 item 的数量增加时,ListView 并不能根据所有 item 一共的数量来撑开布局
- Android --- 进入页面时,不弹出软键盘。当 EditText 被点击时不弹出软键盘,而是调用其他选择器,比如时间选择器等
- Android --- 从相册中选择图片或者拍着选择图片遇到的问题
Android --- 命名规范相关推荐
- Android 命名规范 (提高代码可以读性) 转
转自:http://blog.csdn.net/vipzjyno1/article/details/23542617 刚接触android的时候,命名都是按照拼音来,所以有的时候想看懂命名的那个控件 ...
- Android学习——android命名规范
参考博客:http://blog.csdn.net/vipzjyno1/article/details/23542617 刚接触android的时候,命名都是按照拼音来,所以有的时候想看懂命名的那个控 ...
- 第四章 android 命名规范和编码规范
书里面讲的比较常见,单个人也是有不同的观点: 因为android绝大部分使用java开发的,因此java相关规范适用于android: Google Style: 英文地址:http://google ...
- Android 命名规范
一.包名 包名命名规范:包名一律小写,采用如下规则:[com].[公司名/组织名].[项目名称].[模块名],例如:com.foreverstar.xxx 1.com.xx.应用名称缩写.模块.act ...
- android命名规范阿里,阿里android开发手册 PDF 下载
主要内容: 二.Android 资源文件命名与使用 1. [推荐]资源文件需带模块前缀. 2. [推荐]layout 文件的命名方式. Activity 的 layout 以 module_activ ...
- Android 代码命名规范 -- 提高代码可以读性
项目是团队分工合作,代码可读性非常重要,在开发过程中,命名规范统一尤为重要,最好是团队中统一好大家命名方法,这样对于日后的工作会轻松很多. 在面试的时候,审核一个程序员的编程水平的时候,命名规范也是一 ...
- android 开发规范
前言 在开发中,一个良好的开发习惯以及一个开发规范可能会让你少走很多弯路,也会一定程度上的提高代码的可读性,可维护性和可拓展性.当随着需求的不断变更,需要维护项目的时候.当随着项目的代码量的提升,需要 ...
- Android资源命名规范
Android资源命名规范 最近几个月,大量涉及android资源的相关工作.对于复杂的应用而言,资源命名的规范很有必要.除了开发人员之外,UI设计人员(或者切图相关人员)也需要对资源使用的位置非常清 ...
- android 开发 命名规范
转自:http://www.cnblogs.com/ycxyyzw/p/4103284.html 标识符命名法 标识符命名法最要有四种: 1 驼峰(Camel)命名法:又称小驼峰命名法,除首单词外,其 ...
最新文章
- 龙蜥降世,神龙升级,阿里云投入 20 亿发力操作系统
- python【蓝桥杯vip练习题库】BASIC-21Sine之舞(递归 递推)
- C# 学习笔记(16)ComboBox下拉列表框宽度自适应
- 生成树(光棍 牛客, 思维)
- wkhtmltopd 下载安装以及php环境下的使用
- Windows端口被占用处理方法
- 三年Java开发,java基础常问面试题
- python第八题 查找敏感单词
- Hibernate 一对一外键单向关联
- MySQL高级知识(七)——索引面试题分析
- osql sql2012_您可能不知道SQL Server实用程序-SQLdiag,osql和SqlLocalDB
- 机器学习--文本分析(jieba)
- Java初级程序员学习路线→中高级程序员
- 解读联想重组:终于裁员了
- 关于向量的叉乘右手定则判方向
- 路由在电话网和计算机网中的区别,计算机猫和路由器之间有什么区别
- CICD篇-Travis-CI环境搭建
- 超阅科技001:冰火九重天
- C语言扫雷函数成绩,C语言实现扫雷
- 主叫号码未显示怎么设置_iphone 主叫号码未显示 的骚扰电话怎么拦截呢?