山工商数媒-android项目实训2编码4.开发代码

1、Android 代码规范浪潮优派科技教育注意修订：版本号修订人修订日期修订内容V1.0浪潮优派2017-1-4创建初稿目录1.命名规则1. 1. 1. 1. 1. 2. 2. 3. 3. 5. 62.注释6. 6. 7. 7. 8. 85. 其他注释4. 域变量和常量注释3. 方法注释2. 类注释1. 文件注释10. 其他资源命名9.名8. ID 名7. 布局名6. 异常名5. 常量名4. 变量名3. 方法名2. 类和接口命名1. 包命名. 93.约定俗成9. 9. 10. 10. 104. 一般情况下的注释3. 通用类的注释2. 第库生成代码的注释1. get / set 方法的注释6. X

2、ML 注释1.命名规则包名由小写的字母组成，默认以开头，然后接上根据功能划分的模块名。名称的首字母需要大写，如果由多个单词组成，那么每个单词的首字母需要大写，其他字母小写。采用驼峰命名法来命名。采用驼峰命名法命名。4. 变量名public String getName()publicisExist()3. 方法名class LoginActivityerface OnClickListener2. 类和接口命名com.huashengrun.android.betterus.uicom.huashengrun.android.betterus.ui.widgetcom.huashengrun.

3、android.betterus 1. 包命名非公共的、非静态的域变量用 m 前缀静态域变量用 s 前缀集合类型的变量使用复数形式，若多种集合类型的变量的是相同类型的对象，除了根据功能区分，也可以简单通过集合类型来区分常量需要为 final sic 形式，组成名称的单词必须全部大写，单词之间用下划线隔开。名称必须以结尾。NullPoerExceptionException 6. 异常名private sic finalFADE_IN_TIME = 200;5. 常量名public claser privatemId;private sic User sUser; String mName;pr

4、otectedmAge; publiclevel;public List companies; public List listScores; public Score arrScores;name 是模块的名称或功能的描述，单词必须全部小写，单词之间用下划线隔开。组成名称的单词必须全部小写，单词之间用下划线隔开，名称不需要复杂的层级定位，只需要准确描述所代表控件的功能作用即可，通常在名称前使用控件类型的缩写前缀来避免重复起名的麻烦。name 是模块的名称或功能的描述。类型模板事例TextViewtv_name.xmltv_title.xmlEditTextet_name.xmlet_.xml

5、8. ID名类型模板事例Activityactivity_name.xmlactivity_main.xmlTabtab_name.xmltab_home.xmlDialogdialog_name.xmldialog_login.xmlListItemitem_name.xmlitem_contact.xml7. 布局名控件类型缩写对照表控件类型源文件中缩写资源文件中缩写OK(ZZUT(ZTHZT/SGMK(ZZUT/HZTOHZT8GJOU(ZZUT8HZTXHZT:UMMZZUT:HHZT)NKIQ(U)NQINQ:KZOK:Z+JOZ:KZ+ZKZ/SGMKOK/O类型模板事例8KRGZ

6、OK2G_UZXR_ZETGSK SRXR_ZERUMOT SR2OTKGX2G_UZRR_ZETGSK SRRR_ZERUMOT SRname 是模块的名称或功能的描述。名称一般由模块名称/功能描述 + 后缀组成，后缀是可选的。前缀描述示例ic_图标ic_launchngbg_背景bg_title.png9.名控件类型源文件中缩写资源文件中缩写ListViewLvlvProgressBarPbarpbarScrollViewSclvsclvRelativeLayoutRlytrlytLinearLayoutLlytllytTableLayoutTlyttlytFrameLayoutFlytf

7、lyt遵循见名知意的原则，组成名称的单词必须全部小写，单词之间用下划线隔开。欢迎#2.注释养成良好的注释，对自己的编程能力和团队合作能力有很大的益处。1. 文件注释10. 其他资源命名前缀描述示例sl_状态sl_button.png后缀描述示例无普通状态login.png_p按压状态login_p.png_c选中状态login_c.png_d不可用状态login_d.png源文件的开头需要注释说明当前的文件信息，包括文件名、作者、版本信息、日期、修改记录等。/* * Copyright (C) 2007-2014, by HuaShengRun, Shenzhen, s .* *File: R

8、equestManager.javaAuthor: JiongBull* Ver: 1.0* Create: 2014-8-10*Changes (from 2014-8-10)* 2014-8-10 : 创建 RequestManager.java (JiongBull);* */在类的开头添加类信息的描述.一般情况下需要为每个方法添加注释，包括方法的功能描述，参数信息、返回值、异常信息等，有些约定俗成的方法可以不需要添加注释，请参考约定俗成的说明。/*3. 方法注释/* 管理Volley 的Request, 使用之前需要调用init()进行初始化.*/public class Reques

9、tManager 2. 类注释5. 其他注释/*日志的扩展名.*/public sic final String LOG_EXTEN= .log;/*网络请求队列.*/private RequestQueue mRequestQueue;4. 域变量和常量注释输出日志.*param context Contextparam logLevel 日志等级param tagparam content 输出内容param throwable 异常信息, 若没有异常可为空*/private sic void trace(final Context context, finallogLevel, fina

10、l String tag, final String content, final Throwable throwable) .单行注释view.setImageResource(defaultImageResId); / 无显示默认区块注释3.约定俗成通过 IDE 工具批量生成域变量的 get / set 方法可以不用注释。1. get / set 方法的注释6. XML 注释/* 网络添加渐变动画 */Resourresource = mContext.getResour();final TransitionDrawable transitionDrawable = new TransitionDrawable(new Dra wable new ColorDrawable(android.R.color.transparent),new BitmapDrawable(resource, bmpResponse);view.setBackgroundResource(defaultImageResId);view.setImageDrawable(transitionDrawable); transitionDrawable.sta