Android通用开发规范:包名、模块命名与资源ID详解
需积分: 9 35 浏览量
更新于2024-09-13
1
收藏 21KB DOCX 举报
在Android通用代码开发规范1.0中,开发者被引导遵循一套严谨的编码实践,以提高代码质量和可维护性。本文档详细阐述了多个关键领域的命名规则和最佳实践,确保项目的组织结构清晰,便于团队协作。
1. **应用包名**:
应用包名应遵循`com.公司名.应用名`的格式,这样有助于在Android系统中明确应用程序的归属,便于管理与权限分配。
2. **应用模块分类**:
模块划分按照`com.应用名.模块名`的方式,保持模块间的独立性和清晰性。基础框架模块应被保留,作为整个应用的核心部分。
3. **图片Drawable命名**:
图片命名采用小写字母,单词间以下划线`_`分隔,如`main_btn_login.xml`、`detail_list_bg_press.png`等,通过状态和功能来区分不同样式和状态下的资源。
4. **布局Layout命名**:
布局文件命名同样遵循小写字母和下划线规则。activity布局如`activity_main.xml`,子布局如`main_list_item.xml`,dialog布局为`dialog_alert.xml`,公共布局为`common_title.xml`。
5. **资源ID命名**:
资源ID(如字符串、布局、颜色等)使用`模块_逻辑名称/模块_功能名称`的形式,如`R.string.main_title`或`R.id.main_title_button`,这样能直观反映资源的作用。
6. **类命名**:
类名的设计采用功能描述加后缀的形式,首字母大写,单词间也大写,例如`MainActivity`、`LoginFragment`,这样的命名方式既直观又易于理解。
7. **类方法命名**:
方法命名需清晰描述其功能,通常使用动词短语,如`loadData()`、`showError()`,保持一致性和可读性。
8. **成员变量命名**:
成员变量同样采用描述性强的名字,如`mIsLoginEnabled`,表明其是登录状态的布尔值,`mTitleTextView`则表示用于显示标题的TextView。
9. **关于注释**:
规范要求代码要有详尽的注释,特别是复杂逻辑和不易理解的部分,以便于其他开发者阅读和维护。同时,注释应保持更新,反映代码的实际状态。
总结,Android通用代码开发规范1.0强调了代码组织、命名一致性以及良好的文档注释,这些规则旨在提高代码质量,减少误解,并促进团队间的协作效率。遵循这些规范,可以使项目更易于管理,降低后期维护成本。
2019-08-06 上传
2015-07-13 上传
2014-01-05 上传
2014-09-15 上传
2018-03-23 上传
2021-10-14 上传
2021-09-27 上传
丑小鸭是白天鹅
- 粉丝: 17
- 资源: 5
最新资源
- 构建基于Django和Stripe的SaaS应用教程
- Symfony2框架打造的RESTful问答系统icare-server
- 蓝桥杯Python试题解析与答案题库
- Go语言实现NWA到WAV文件格式转换工具
- 基于Django的医患管理系统应用
- Jenkins工作流插件开发指南:支持Workflow Python模块
- Java红酒网站项目源码解析与系统开源介绍
- Underworld Exporter资产定义文件详解
- Java版Crash Bandicoot资源库:逆向工程与源码分享
- Spring Boot Starter 自动IP计数功能实现指南
- 我的世界牛顿物理学模组深入解析
- STM32单片机工程创建详解与模板应用
- GDG堪萨斯城代码实验室:离子与火力基地示例应用
- Android Capstone项目:实现Potlatch服务器与OAuth2.0认证
- Cbit类:简化计算封装与异步任务处理
- Java8兼容的FullContact API Java客户端库介绍