Android中的一些编码规范

最新推荐文章于 2023-07-29 10:48:02 发布

原创最新推荐文章于 2023-07-29 10:48:02 发布 · 694 阅读

0 ·

CC 4.0 BY-SA版权

Android开发专栏收录该内容

4 篇文章

订阅专栏

本文详细介绍了Android应用开发中的一系列命名规范和代码组织建议，包括成员变量、静态变量、常量的命名约定，四大组件(Activity、Service、ContentProvider、BroadcastReceiver)的命名及包结构安排，以及注释和文档编写指南。

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

1、成员变量以m开头
2、静态变量以s开头
3、常量必须所有字母大写, 单词之间以下划线隔开
4、重要的变量必须加注释

5、四大组件的命名必须以统一的名词结束

例如：

Activity必须以"Activity"结束, 如LoginActivity;
Service必须以"Service"结束, 如WebSocketService;
ContentProvider必须以"Provider"结束, 如UserInfoProvider
BroadcastReceiver必须以"Receiver"结束, 如AddShortcutReceiver

6、四大组件最好放在独立的包中

例如：

Activity放在包com.singuloid.email.activity中

Service放在包com.singuloid.email.service中

BroadcastReceiver放在包com.singuloid.email.recevier中

ContentProvider放在包com.singuloid.email.provider中

7、在AndroidManifest.xml文件中的组件信息, 必须以Activity, Service, ContentProvider, BroadcastReceiver的顺序排放, 重要的组件尽量写注释
8、源文件中的每个类都要有注释, 说明这个类的作用, 以及为什么要有这个类.
9、在程序逻辑的关键分支处添加注释
10、写注释的时候, 不仅要说明实现的逻辑, 最重要的是说明为什么这么做