标识符命名法
标识符命名法最要有四种:
1 驼峰(Camel)命名法:又称小驼峰命名法,除首单词外,其余所有单词的第一个字母大写。
2 帕斯卡(pascal)命名法:又称大驼峰命名法,所有单词的第一个字母大写
3 下划线命名法:单词与单词间用下划线做间隔。
4 匈牙利命名法:广泛应用于微软编程环境中,在以Pascal命名法的变量前附加小写序列说明该变量的类型。 量的取名方式为:<scope_> + <prefix_> + <qualifier>范围前缀,类型前缀,限定词。
个人觉得标识符命名原则:尽可能的用最少的字符而又能完整的表达标识符的含义。
英文缩写原则:
1 较短的单词可通过去掉“元音”形成缩写
2 较长的单词可取单词的头几个字母形成缩写
3 此外还有一些约定成俗的英文单词缩写.
我们使用中:
package命名: 全部使用小写字母。一级包名为com,二级包名为xx(可以是公司或则个人的随便),三级包名根据应用进行命名,四级包名为模块名或层级名。
类的命名:大驼峰的命名法,如:MainActivity
方法的命名:小驼峰的命名法,如:startActivity。
接口的命名: 命名规则与类一样采用大驼峰命名法,多以able或ible结尾。
变量的命名:采用小驼峰命名法。
注意:作用统一的变量,在结尾加一个量词进行区分更容易搜索和记忆,如strNameFirst和strNameLast
常量的命名:常量全部大写,如:MIN MAX
布局文件的命名:布局文件使用“前缀_逻辑名”的方式,单词全部小写:
①activity的布局——activity_xxx
②fragment的布局——fragment_xxx
③自定义控件的布局——view_xxx
④对话框的布局——dialog_xxx
⑤列表项的布局——item_xxx
资源文件的命名:资源文件使用“模块名_逻辑名”方式,单词全部小写:
①按钮以btn为前缀,如果是图片可以是btn_login.png,按钮的点击形态可以是btn_login_normal.xml以及btn_login_pressed.xml
②图片的命名以ic为前缀,例如ic_share.png
③背景图片可以用bg作为前缀。
④shape:shape_text_bg
⑤selector:selector_home
注释的规范:
Javadoc 常见的标记
@param 参数的说明
@return 返回值的说明
@throws 异常的描述
@version 模块的版本号
@author 模块作者
@see 参考转向
@deprecated 标记是否过时
其他编码规范:除了以上的规范,其他比较重要的注意点,总结如下:
①java中尽量不出现中文
②服务端可以实现的,就不要放在客户端
③引用第三方库要慎重,避免应用大容量的第三方库,导致客户端包非常大
下面为常见的英文单词缩写:
程序中使用单词缩写原则:不要用缩写,除非该缩写是约定俗成的。
命名规范:
1 包(packages):
采用反域名命名规则,全部使用小写字母。一级包名为com,二级包名为xx(可以是公司或则个人的随便),三级包名根据应用进行命名,四级包名为模块名或层级名
2 类(classes):
名词,采用大驼峰命名法,尽量避免缩写,除非该缩写是众所周知的, 比如HTML,URL,如果类名称中包含单词缩写,则单词缩写的每个字母均应大写。
3 接口(interface):
命名规则与类一样采用大驼峰命名法,多以able或ible结尾,
如interface Runna ble ; interface Accessible 。
4 方法(methods):
动词或动名词,采用小驼峰命名法例如:onCreate(),run()
5 变量(variables)采用小驼峰命名法。
类中控件名称必须与xml布局id保持一致。
用统一的量词通过在结尾处放置一个量词,就可创建更加统一的变量,它们更容易理解,也更容易搜索。例如,请使用strCustomerFirst和strCustomerLast,而不要使用strFirstCustomer和strLastCustomer。
量词列表:量词后缀说明
First 一组变量中的第一个
Last 一组变量中的最后一个
Next 一组变量中的下一个变量
Prev 一组变量中的上一个
Cur 一组变量中的当前变量
6 常量(Constants)
全部大写,采用下划线命名法.例如:MIN_WIDTH
7 资源文件(图片drawable文件夹下):
全部小写,采用下划线命名法,加前缀区分
命名模式:activity名称逻辑名称/common逻辑名称
如果有多种形态如按钮等除外如btn_xx.xml(selector)
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文件夹下):
全部小写,采用下划线命名法,加前缀区分。
前面为动画的类型,后面为方向
动画命名例子:
规范写法
10 资源ID(resourcesid):
(大小写规范与方法名一致,采用小驼峰命名法。命名规范为“资源控件的缩写 名”+“变量名”。注意:页面控件名称应该和控件id名保持一致)
strings.xml,colors.xml等中的id命名:
命名模式:activity名称功能模块名称逻辑名称/activity名称逻辑名称/common逻辑名称
strings.xml中,使用activity名称注释,将文件内容区分开来
11 layout中的id命名
命名模式为:view缩写_模块名称_view的逻辑名称
view的缩写详情如下:
网友评论