聊聊代码规范(Code Style)

最新推荐文章于 2025-05-19 13:28:18 发布

原创最新推荐文章于 2025-05-19 13:28:18 发布 · 2.7k 阅读

6 ·

CC 4.0 BY-SA版权

文章标签：

#android #代码规范 #开发

编码专栏收录该内容

1 篇文章

订阅专栏

本文详细介绍了Android开发中的代码规范，包括命名法、包名、类名、方法名、变量、常量、资源文件等的命名规则，强调了良好代码规范对于项目开发、维护和扩展的重要性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

良好的代码规范对项目的开发、维护、扩展都能起到至关重要的作用。
本文内容结合自身与看到的资源进行整理，涉及到类、变量、常理、包名、资源等

命名法介绍：

驼峰(Camel)命名法:又称小驼峰命名法，除首单词外，其余所有单词的第一个字母大写。
例如：mString
帕斯卡(pascal)命名法:又称大驼峰命名法，所有单词的第一个字母大写
例如：MainActivity
下划线命名法:单词与单词间用下划线做间隔。
例如：list_size

英文缩写原则：

较短的单词可通过去掉“元音”形成缩写
较长的单词可取单词的头几个字母形成缩写
此外还有一些约定成俗的英文单词缩写.

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

命名规范

包名

base包名采用反域名命名规则，全部使用小写字母。一级包名为com，二级包名为xx（可以是公司或则个人的随便），三级包名根据应用进行命名。例如：com.cc.frame
包名路径对后续的项目扩展维护很重要，所以UI类与逻辑类最好分开包名路径放置

常用说明

包名                              此包中包含

com.cc.frame.activities           页面用到的Activity类 (activities层级名用户界面层) 
com.cc.frame.base                 页面中每个Activity类共享的可以写成一个BaseActivity类 (基础共享的类)
com.cc.frame.fragments            页面用到的Fragment类
com.cc.frame.adapter              页面用到的Adapter类 (适配器的类)
com.cc.frame.utils                公共工具方法类 
com.cc.frame.db                   数据库操作类
com.cc.frame.services             Service服务
com.cc.frame.broadcasts           Broadcast服务
com.cc.frame.views                自定义的View类等
com.cc.frame.model                数据模型类

类名

名词，采用大驼峰命名法，尽量避免缩写，除非该缩写是众所周知的，例如：HTML,URL，如果类名称中包含单词缩写，则单词缩写的每个字母均应大写。

常用说明

类                    描述                     例子
Activity类            Activity为后缀标识        欢迎页面类WelcomeActivity      
Adapter类             Adapter为后缀标识         新闻详情适配器NewDetailAdapter 
公共工具方法类          Utils或Manager为后缀标识   线程池管理类：ThreadPoolManager 文件管理类：FileUtils
数据库类               以DBHelper后缀标识         新闻数据库：NewDBHelper
BroadcastReceive类    以Broadcast为后缀标识      时间通知TimeBroadcast
直接写的共享基础类       以Base开头                BaseActivity,BaseFragment

方法名

动词或动名词，采用小驼峰命名法例如: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前缀标识

变量

采用小驼峰命名法。类中控件名称必须与xml布局id保持一致。
用统一的量词通过在结尾处放置一个量词，就可创建更加统一的变量，它们更容易理解，也更容易搜索。例如，请使用strCustomerFirst和strCustomerLast，而不要使用strFirstCustomer和strLastCustomer。

1.局部变量。
      每个单词以下划线分割，全部小写。
      如app_count。

2. 类私有变量（非静态），除视图类变量。
      m开头，其他单词以大写开头，boolean型变量，以is开头
      如mAppCount，isLoading

3.  类公有变量（非静态）
      小写开头，其他单词为大写开头
      如 appCount

4.  类的静态变量
      s开头，其他单词以大写开头
      如 sSingleInstance 

5.  类的常量
      全部大写，以下划线连起来。
      如 SOME_CONSTANT

6.  视图变量
      以视图变量的两个字母小写开头，其他以大写开头。
      如TextView 的tvAppName
      此命名方法，使用用于界面id命名

常量

常量（Constants）全部大写,采用下划线命名法.例如：MIN_WIDTH

资源文件

全部小写，采用下划线命名法，加前缀区分，命名模式：activity名称逻辑名称/common逻辑名称

常用说明

名称                  功能
btn_xx               按钮图片使用btn_整体效果（selector）
btn_xx_normal        按钮图片使用btn_正常情况效果
btn_xx_pressed       按钮图片使用btn_点击时候效果
bg_head              背景图片使用bg_功能_说明
def_search_cell      默认图片使用def_功能_说明
ic_more_help         图标图片使用ic_功能_说明