编程一開始就应该养成的好习惯

Posted 2020-09-22 ljbguanli

       有些编程规范，学编程第一天就应该了解，这些习惯比你多学两章知识来的更为实际。他们甚至可能会直接影响你的编程生涯，所以。不要一開始认为这些习惯都不重要。有非常多同学认为等到技术成熟的时候再考虑它们，殊不知。坏习惯一旦养成须要花费多大的经历才干更正。一開始就对自己要求严格一些，慢慢的养成习惯，却也不认为这些规范是束缚，而认为是天经地义的事情。

        好的编程命名习惯不止是能够提高代码的可读性，事实上还能够大大提高你的开发效率，比如，android中各种控件的命名，好的命名能够让你高速的在Activity中找到所要引用的控件。不规则的命名会给自己造成不必要的混淆。须要花费一些时间区分这些命名，另外规则的命名还可能会预防命名反复的问题。

        这些规则不是靠自己死记硬背出来的，一開始养成好习惯会流淌在程序猿的血液里，坚持从第一行代码開始，严格依照命名规范来运行。久而久之就会认为这是一件十分正常和合理的事情。一開始是痛苦的，却也是值得的。

        怎么才算是合理的命名、好的编程习惯呢。自己认为的可不一定是合理的，我们须要找到权威的解释，能够參考官方给出的命名规范和格式，也能够參考一些大公司的编程规范，绝对会让你受益匪浅。

网上一些资料也是能够參考的，我整理了一些Android开发方面须要注意的命名和编程规范，大家能够參考一下。也能够发表自己的看法，丰富这一文档。

1.java代码中不出现中文，最多凝视中能够出现中文（尽量不要用拼音命名啊，那样显得太low了！

）

2.局部变量命名、静态成员变量命名
仅仅能包括字母。单词首字母出第一个外，都为大写，其它字母都为小写。

3.常量命名
仅仅能包括字母和_，字母所有大写，单词之间用_隔开。（API_KEY）

4.layout中的id命名
命名模式为： view缩写_模块名称_view的逻辑名称（这个比較重要啊。非经常常使用的！

能够findViewById()中高速找到控件）

view的缩写详情例如以下：

• LayoutView：lv

• RelativeView:rv

• TextView:tv

• ImageView:iv

• ImageButton:im

• Button:btn

5.activity中的view变量命名

命名模式为：逻辑名称+view缩写（mUserNameTv）

建议：假设layout文件非常复杂，建议将layout分成多个模块，每一个模块定义一个moduleViewHolder，其成员变量包括所属view

6.strings.xml中的id命名
命名模式：activity名称_功能模块名称_逻辑名称/activity名称_逻辑名称/common_逻辑名称
strings.xml中。使用activity名称凝视，将文件内容区分开来。

7.drawable中的图片命名
命名模式：activity名称_逻辑名称/common_逻辑名称

8.styles.xml：将layout中不断重现的style提炼出通用的style通用组件，放到styles.xml中；

9.使用layer-list和selector

10.图片尽量分拆成多个可重用的图片

11.服务端能够实现的，就不要放在client

12.引用第三方库要谨慎，避免应用大容量的第三方库，导致client包非常大

13.处理应用全局异常和错误，将错误以邮件的形式发送给服务端

14.图片的.9处理(保证拉伸不变形。做背景图片的一半要处理)

15.使用静态变量方式实现界面间共享要谨慎

16.Log(系统名称 模块名称 接口名称，具体描写叙述)

17.单元測试（逻辑測试、界面測试）

18.不要重用父类的handler。相应一个类的handler也不应该让其子类用到，否则会导致message.what冲突

19.activity中在一个View.OnClickListener中处理所有的逻辑（switch分支推断处理）

20.strings.xml中使用%1$s实现字符串的通配

21.假设多个Activity中包括共同的UI处理，那么能够提炼一个CommonActivity。把通用部分叫由它来处理。其它activity仅仅要继承它就可以

22.使用button+activitgroup实现tab效果时。使用Button.setSelected(true)，确保button处于选择状态，并使activitygroup的当前activity与该button相应

23.假设所开发的为通用组件。为避免冲突，将drawable/layout/menu/values目录下的文件名称添加前缀

24.数据一定要效验，比如字符型转数字型，假设转换失败一定要有缺省值。服务端响应数据是否有效推断；

25.同一个client假设要放在不同的市场，并且要统计各个市场下载及使用数据时针对不同的client打不同的包，唯一的差别是versionName。apk文件名称为versionName.apk。在升级时。要将自己的versionCode和versionName一并传给服务端，假设须要升级，则下载versionName相相应的apk

关于是否要强制升级：

• 1).无论何种情况都强制升级

• 2).推断用户的版本号和当前最新版本号，假设兼容则强制升级，否则可选。

26.有的button要避免反复点击

以下是网上的资料，非常有必要看一看哦！真的非常实用！

标识符命名法
标识符命名法最要有四种:

1 驼峰(Camel)命名法:又称小驼峰命名法。除首单词外，其余所有单词的第一个字母大写。

2 帕斯卡(pascal)命名法:又称大驼峰命名法。所有单词的第一个字母大写

3 下划线命名法:单词与单词间用下划线做间隔。

4 匈牙利命名法:广泛应用于微软编程环境中。在以Pascal命名法的变量前附加小写序列说明该变量的类型。 量的取名方式为：<scope_> + <prefix_> + <qualifier>范围前缀。类型前缀。限定词。

个人认为标识符命名原则:尽可能的用最少的字符而又能完整的表达标识符的含义。

英文缩写原则：
1 较短的单词可通过去掉“元音”形成缩写
2 较长的单词可取单词的头几个字母形成缩写
3 此外另一些约定成俗的英文单词缩写.

以下为常见的英文单词缩写:

名称	缩写
icon	ic （主要用在app的图标）
color	cl（主要用于颜色值）
divider	di（主要用于分隔线，不仅包括Listview中的divider，还包括普通布局中的线）
selector	sl（主要用于某一view多种状态，不仅包括Listview中的selector，还包括button的selector）
average	avg
background	Bg（主要用于布局和子布局的背景）
buffer	buf
control	ctrl
delete	del
document	doc
error	err
escape	esc
increment	inc
infomation	info
initial	init
image	img
Internationalization	I18N
length	len
library	lib
message	msg
password-	pwd
position	pos
server	srv
string	str
temp	tmp
window	wnd(win)

程序中使用单词缩写原则：不要用缩写，除非该缩写是约定俗成的。

命名规范：

1  包（packages）: 採用反域名命名规则。所有使用小写字母。一级包名为com。二级包名为xx（能够是公司或则个人的随便），三级包名依据应用进行命名，四级包名为模块名或层级名

包名	此包中包括
com.xx.应用名称缩写.activities	页面用到的Activity类 (activities层级名用户界面层)
com.xx.应用名称缩写.base	页面中每一个Activity类共享的能够写成一个i额BaseActivity类 (基础共享的类)
com.xx.应用名称缩写.adapter	页面用到的Adapter类 (适配器的类)
com.xx.应用名称缩写.tools	此包中包括：公共工具方法类（tools模块名）
com.xx.应用名称缩写.bean (或则 com.xx.应用名称缩写.unity )	此包中包括：元素类
com.xx.应用名称缩写.db	数据库操作类
com.xx.应用名称缩写.view (或则 com.xx.应用名称缩写.ui )	自己定义的View类等
com.xx.应用名称缩写.service	Service服务
com.xx.应用名称缩写.broadcast	Broadcast服务

2  类（classes）：名词，採用大驼峰命名法。尽量避免缩写。除非该缩写是众所周知的，  比方html,URL，假设类名称中包括单词缩写，则单词缩写的每一个字母均应大写。

类	描写叙述	比如
activity 类	Aty或者Activity为后缀标识	欢迎页面类WelcomeAty.或者WelcomeActivity
Adapter类	Adp或者Adapte 为后缀标识	新闻详情适配器NewtDetailAdp或则直接  NewDetailAdapter
解析类	Hlr为后缀标识	首页解析类HomePosterHlr
公共方法类	Tools或Manager为后缀标识	线程池管理类：ThreadPoolManager             日志工具类：LogTools
数据库类	以DBHelper后缀标识	新闻数据库：NewDBHelper
Service类	以Service为后缀标识	时间服务TimeService
BroadcastReceive类	以Broadcast为后缀标识	时间通知TimeBroadcast
ContentProvider	以Provider为后缀标识
直接写的共享基础类	以Base开头	BaseActivity,BaseFragment

3  接口（interface）：命名规则与类一样採用大驼峰命名法，多以able或ible结尾，如interface Runna ble ;
                     interface Accessible 。

4  方法（methods）：动词或动名词，採用小驼峰命名法比如:onCreate(),run()

方法	说明
initXX()	初始化相关方法,使用init为前缀标识。如初始化布局initView()
isXX()	checkXX()方法返回值为boolean型的请使用is或check为前缀标识
getXX()	返回某个值的方法，使用get为前缀标识
processXX()	对数据进行处理的方法，尽量使用process为前缀标识
displayXX()	弹出提示框和提示信息。使用display为前缀标识
saveXX()	与保存数据相关的，使用sav为e前缀标识
resetXX()	对数据重组的。使用reset前缀标识
clearXX()	清除数据相关的
removeXXX()	清除数据相关的
drawXXX()	绘制数据或效果相关的，使用draw前缀标识

5  变量（variables）採用小驼峰命名法。

类中控件名称必须与xml布局id保持一致。

用统一的量词通过在结尾处放置一个量词，就可创建更加统一的变量。它们更easy理解，也更easy搜索。比如，请使用strCustomerFirst和strCustomerLast。而不要使用strFirstCustomer和strLastCustomer。
量词列表：量词后缀说明
First  一组变量中的第一个
Last   一组变量中的最后一个
Next   一组变量中的下一个变量
Prev   一组变量中的上一个
Cur    一组变量中的当前变量
 
6  常量（Constants）所有大写,採用下划线命名法.比如：MIN_WIDTH


7  资源文件（图片drawable目录下）：所有小写，採用下划线命名法。加前缀区分

命名模式：activity名称_逻辑名称/common_逻辑名称

假设有多种形态如button等除外如btn_xx.xml（selector）

名称	功能
btn_xx	button图片使用btn_总体效果（selector）
btn_xx_normal	button图片使用btn_正常情况效果
btn_xx_press	button图片使用btn_点击时候效果
bg_head	背景图片使用bg_功能_说明
def_search_cell	默认图片使用def_功能_说明
icon_more_help	图标图片使用icon_功能_说明
seg_list_line	具有分隔特征的图片使用seg_功能_说明
sel_ok	选择图标使用sel_功能_说明

命名后缀：

后缀	说明
unit	在使用xml的tilemode来配图片时，element图片使用此后缀
nor	图片的状态，代表普通状态
hl	图片的状态，代表高亮状态
press	图片的状态，代表按下状态
select	图片的状态。代表其所占的view被选中
unselect	图片的状态，代表其所占的view没有被选中

 

 

 

 

 

 

 

 

 

 

8     资源布局文件（XML文件（layout布局文件））：

 所有小写。採用下划线命名法

1)．contentview命名, Activity默认布局。以去掉后缀的Activity类进行命名。不加后缀：

       功能模块.xml

       比如：main.xml、more.xml、settings.xml

        或则：activity_功能模块.xml

        比如：activity_main.xml、activity_more.xml

2)．Dialog命名：dialog_描写叙述.xml

       比如：dlg_hint.xml

2)．PopupWindow命名：ppw_描写叙述.xml

       比如：ppw _info.xml

3). 列表项命名listitem_描写叙述.xml

       比如：listitem_city.xml

4)．包括项：include_模块.xml

       比如：include_head.xml、include_bottom.xml

5)．adapter的子布局：功能模块_item.xml

       比如：main_item.xml、

9   动画文件（anim目录下）：所有小写，採用下划线命名法，加前缀区分。

 

//前面为动画的类型，后面为方向

动画命名样例	规范写法	备注
fade_in	淡入
fade_out	淡出
push_down_in	从下方推入
push_down_out	从下方推出
push_left	推像左方
slide_in_from_top	从头部滑动进入
zoom_enter	变形进入
slide_in	滑动进入
shrink_to_middle	中间缩小

10    资源ID（resourcesid）：大写和小写规范与方法名一致。採用小驼峰命名法。命名规范为“资源控件的缩写  名”+“变量名”。注意：页面控件名称应该和控件id名保持一致

 strings.xml，colors.xml等中的id命名：

命名模式：activity名称_功能模块名称_逻辑名称/activity名称_逻辑名称/common_逻辑名称

strings.xml中。使用activity名称凝视。将文件内容区分开来

11   layout中的id命名

命名模式为：view缩写_模块名称_view的逻辑名称

view的缩写详情例如以下：

控件	缩写
LayoutView	lv
RelativeView	rv
TextView	tv
Button	btn
ImageButton	imgBtn
ImageView	mgView 或则 iv
CheckBox	chk
RadioButton	rdoBtn
analogClock	anaClk
DigtalClock	dgtClk
DatePicker	dtPk
EditText	edtTxt
TimePicker	tmPk
toggleButton	tglBtn
ProgressBar	proBar
SeekBar	skBar
AutoCompleteTextView	autoTxt
ZoomControls	zmCtl
VideoView	vdoVi
WdbView	webVi
RantingBar	ratBar
Tab	tab
Spinner	spn
Chronometer	cmt
ScollView	sclVi
TextSwitch	txtSwt
ImageSwitch	imgSwt
listView	lVi 或则lv
ExpandableList	epdLt
MapView	mapVi

 

 

 

好习惯终于决定你能走多远。不要吝啬培养好习惯哦。也不要由于时间紧的借口留下技术债务，这些债务积累到一定程度一定会让你懊悔莫及！开发注意小细节就会大大提高代码质量。