#OneKeyHelp_v3.0 编码规范: 1.编码格式统一为UTF-8; 2.常用shift+ctrl+f格式化代码; 3.代码格式化宽度为200; 4.图片文件,存放在drawable-xxx文件夹内;图标存在mipmap-xxx文件夹内; 5.经常保存; 6.尽量使用真机调试; 7.不定期的查看as以及sdk更新,尽量使用最新版本进行开发。
开发注意点: 1.空值错误!!!(主要重点) 2.线程安全。 3.网络请求失败后的处理。 4.数组越界错误!!!(重点)
结构规范: 1.分包明确,不同类型的类不要放在同一个特定包中; 2.同一包下类太多,进行再次细分; 3.View包一定要放在主包之外,方便更改主包名(xml中使用自定义view的地方就不用改)
代码规范: 1.经常使用注释; 2.需要改进或添加功能的地方使用//TODO标记; 3.代码中避免出现硬编码,常量在类开头进行申明(再议); 4.分组规范化,不同类型变量或不同功能的操作之间空一行;方法与方法之间空一行; 5.相关联的方法尽量放在一起; 6.使用listview或者gridview,一定使用复用,无论数据量多少,采用ViewHolder内部类实现;(或直接使用RecycleView) 7.使用System.out进行调试信息输出的,调试完成后,将System.out删除或注释掉;(尽量少用) 8.多余的import进行删除,减少警告出现; 9.未使用变量进行删除,如果今后需要使用,进行注释,并添加相关说明; 10.代码中用到的字符串,写到strings.xml中; 11.同一个java文件中代码量不宜过长,太长的话,考虑进行分离或代码重用。
命名规范: 1.xml中id的命名规则为:控件类型缩写_模块_名称(或反过来)例如layout_main_root,btn_main_jump; 2.变量名称命名规则:m(可无)+名称+控件缩写。例如:mWindBtn或windBtn; 3.方法名一律使用英文,严禁拼音和数字,且必需有意义;2可以用来代替to或two; 4.boolean类型命名使用is前缀或tf后缀,例如isopen或opentf; 5.类名命名规范:模块名+基础类;例如:FunctionActivity,HelpFragment; 6.xml文件的命名规则:类型+模块+名称(可无);例如fragment_home; 7.命名严禁无意义,临时变量可以。例如for循环中的int i; 8.常量命名一律全部大写; 9.类名首字母大写,变量名首字母小写,方法名首字母小写(均采用驼峰命名法); 10.类名中禁止特殊符号;
Git使用规范: 1.每次Push前先Pull; 2.未完成的功能禁止Push,注释恢复到之前状态后才可Push;本地代码无法运行禁止Push; 3.出现冲突,与冲突版本的提交者讨论如何解决冲突; 4.只需上传代码文件、第三方库、AndroidMainfest.xml和混淆相关文件;.class文件不上传; 5.Push备注中写明实现什么功能; 6.每天更新一次代码,每天走之前提交一次代码;重要!!! 7.提交的时候检查是否提交完成。重要!!!!!
调试信息: 1.调试信息使用框架内的LOG类进行输出; 2.输出信息之前带个人标记,例如“NAME---”+调试信息,方便调试; 3.每次打包,关闭调试信息的输出再打包(debug版本可以不关)。
打包规范: 1.打包所用的key一定要上传至SVN中,并上传txt文档记录密码。 2.打包的内部测试所用debug版本,命名一律为APPNAME-版本号-betaX-日期.apk(X为当天第几个版本)。 3.每次提交测试,必须是apk+更新日志一起提交,方便测试人员了解更改情况。