Android中的命名规范

以你之姓@ 2022-08-02 09:58 204阅读 0赞

xml:(全为小写)

> layout:layout\_模块名(包名的最后一个文件夹名)\_组件名(类名除去四大组件名:如MainActivity就为main)

> view: view\_母layout组件名(layout名)\_组件名(组件全拼)

> color.xml:模块名(包名的最后一个文件夹名)\_类名(除去四大组件名:如MainActivity就为main)\_组件名(组件全拼)\_

颜色名(颜色的英文)

> strings.xml :模块名(包名的最后一个文件夹名)\_类名(除去四大组件名:如MainActivity就为

main)\_字符串名(要反映字符的意思)

> ...

> 都按照这个结构:模块名\_类名(除去四大组件名:如MainActivity就为main)\_组件名(组件全拼)\_(尺寸,颜色,字符串等

等,全小写)

class:

> 主模块类名:模块名(包名的最后一个文件夹名,首字母大写)+Activity

> 子模块类名(由主模块调用,在同一个包下):功能名或子组件名(子组件:比如一个一个窗口或者一个组件)+Activity(或

者四大组件)

> 工具类(模块名+Util):例如,

> > Json转换工具:JsonUtil
> > 
> > 数据库连接工具:DBUtil

> 服务类(模块名+Service):例如,

> >   
> >

class中的变量:

> xml组件(和组件的id名对应):组件名(如下例子1,2所示)\_功能名或描述名(全部小写代表是一个xml组件)

> > 例1:如(如果该组件有多于两个大写字母则使用大写字母对应的小写):

> > > EditText:et\_longitude,et\_radius

> > > TextView:tv\_longitude,tv\_radius

> > > SharedPreferences:sp\_num

> > 例2:如(如果该组件只有一个大写字母则使用固定名称,如下):

> > > Button:btn\_true

> 集合名称:

> > ArrayList(功能名或描述名+List):personList

> > HashMap(功能名或描述名+Map):personMap
> 
> > SortedSet(功能名或描述名+Set):personSet
> 
> > 数组(描述或功能名+Array):jsonArray
> 
> > String:jsonString

> 临时变量名(尽量少用):i,j,m,n,

> 常量:形容词\_名词...(全部大写)

class中的方法:

动词+名词\[And(连词)+动词+名词\](各单词首字母大写)

# 一、首先明确命名规范问题： #

本部分转载自：[/images/20220731/abe00bc6073d45afa3040c6ed8e319e2.png][http_blog.csdn.net_scy411082514_article_details_7424485]

# 包的命名　 （全部小写，由域名定义） #

Java包的名字都是由小写单词组成。但是由于Java面向对象编程的特性，每一名Java程序员都 可以编写属于自己的Java包，为了保障每个Java包命名的唯一性，在最新的Java编程规范中，要求程序员在自己定义的包的名称之前加上唯一的前缀。 由于互联网上的域名称是不会重复的，所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。  
例如：net.frontfree.javagroup

类的命名 （单词首字母大写）

根据约定，Java类名通常以大写字母开头，如果类名称由多个单词组成，则每个单词的首字母均应为大 写例如TestPage；如果类名称中包含单词缩写，则这个所写词的每个字母均应大写，如：XMLExample,还有一点命名技巧就是由于类是设计用来 代表对象的，所以在命名类时应尽量选择名词。 　　  
例如： Graphics

方法的命名 （首字母小写，字母开头大写）

方法的名字的第一个单词应以小写字母作为开头，后面的单词则用大写字母开头。  
例如：drawImage

常量的命名 （全部大写 ，常加下划线）  
常量的名字应该都使用大写字母，并且指出该常量完整含义。如果一个常量名称由多个单词组成，则应该用下划线来分割这些单词。  
例如：MAX\_VALUE

参数的命名

参数的命名规范和方法的命名规范相同，而且为了避免阅读程序时造成迷惑，请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。

Javadoc注释

Java除了可以采用我们常见的注释方式之外，Java语言规范还定义了一种特殊的注释，也就是我们 所说的Javadoc注释，它是用来记录我们代码中的API的。Javadoc注释是一种多行注释，以/\*\*开头，而以\*/结束，注释可以包含一些 HTML标记符和专门的关键词。使用Javadoc 注释的好处是编写的注释可以被自动转为在线文档，省去了单独编写程序文档的麻烦。  
例如：

/\*\*  
\* This is an example of  
\* Javadoc  
\* @author darchon  
\* @version 0.1, 10/11/2002  
\*/

在每个程序的最开始部分，一般都用Javadoc注释对程序的总体描述以及版权信息，之后在主程序中 可以为每个类、接口、方法、字段添加 Javadoc注释，每个注释的开头部分先用一句话概括该类、接口、方法、字段所完成的功能，这句话应单独占据一行以突出其概括作用，在这句话后面可以跟 随更加详细的描述段落。在描述性段落之后还可以跟随一些以Javadoc注释标签开头的特殊段落，例如上面例子中的@auther和@version，这 些段落将在生成文档中以特定方式显示。

**方法注释的内容**

1、该方法是做什么的。

2、传入什么样的参数给这个方法。@param  
3、异常处理。@throws  
4、这个方法返回什么。@return

变量和常量命名

变量的命名

主要的的命名规范有以下三种：  
Camel 标记法:首字母是小写的,接下来的单词都以大写字母开头  
Pascal 标记法:首字母是大写的,接下来的单词都以大写字母开头  
匈牙利标记法:在以Pascal标记法的变量前附加小写序列说明该变量的类型

在Java我们一般使用匈牙利标记法，基本结构为scope\_typeVariableName，它 使用1-3字符前缀来表示数据类型，3个字符的前缀必须小写，前缀后面是由表意性强的一个单词或多个单词组成的名字，而且每个单词的首写字母大写，其它字 母小写，这样保证了对变量名能够进行正确的断句。例如，定义一个整形变量，用来记录文档数量：intDocCount，其中int表明数据类型，后面为表 意的英文名，每个单词首字母大写。这样，在一个变量名就可以反映出变量类型和变量所存储的值的意义两方面内容，这使得代码语句可读性强、更加容易理解。 byte、int、char、long、float、 double、boolean和short。

数据类型/前缀(附)  
byte b  
char c  
short sh  
int i  
long l  
char c  
string s  
float f  
double d  
hashtable h  
\[\] arr  
List lst  
Vector v  
StringBuffer sb  
Boolean b  
Byte bt  
Map map  
Object ob

对于在多个函数内都要使用的全局变量，在前面再增加“g\_”。例如一个全局的字符串变量：g\_strUserInfo。  
  
在变量命名时要注意以下几点：

· 选择有意义的名字，注意每个单词首字母要大写。

· 在一段函数中不使用同一个变量表示前后意义不同的两个数值。

· i、j、k等只作为小型循环的循环索引变量。

**集合、数组** 应该从命名中体现其复数的含义，例如加后缀s或前缀some，名字要有意义。

临时变量通常被取名为i，j，k，m 和n，它们一般用于整型；c，d，e，它们一般用于字符型。

·避免用Flag来命名状态变量。

· 用Is来命名逻辑变量，如：blnFileIsFound。通过这种给布尔变量肯定形式的命名方式，使得其它开发人员能够更为清楚的理解布尔变量所代表的意义。

· 如果需要的话，在变量最后附加计算限定词，如：curSalesSum。

· 命名不相包含，curSales和curSalesSum。

· static final 变量(常量)的名字应该都大写，并且指出完整含义。

· 如果需要对变量名进行缩写时，一定要注意整个代码中缩写规则的一致性。例如，如果在代码的某些区域中使用intCnt，而在另一些区域中又使用intCount，就会给代码增加不必要的复杂性。建议变量名中尽量不要出现缩写。

· 通过在结尾处放置一个量词，就可创建更加统一的变量，它们更容易理解，也更容易搜索。例如，请使用 strCustomerFirst和strCustomerLast，而不要使用strFirstCustomer和strLastCustomer。常 用的量词后缀有：First（一组变量中的第一个）、Last（一组变量中的最后一个）、Next（一组变量中的下一个变量）、Prev（一组变量中的上 一个）、Cur（一组变量中的当前变量）。

· 为每个变量选择最佳的数据类型，这样即能减少对内存的需求量，加快代码的执行速度，又会降低出错的可能性。用于变量的数据类型可能会影响该变量进行计算所产生的结果。在这种情况下，编译器不会产生运行期错误，它只是迫使该值符合数据类型的要求。这类问题极难查找。

· 尽量缩小变量的作用域。如果变量的作用域大于它应有的范围，变量可继续存在，并且在不再需要该变量后的很长时间内仍然占用资源。它们的主要问题是，任何类 中的任何方法都能对它们进行修改，并且很难跟踪究竟是何处进行修改的。占用资源是作用域涉及的一个重要问题。对变量来说，尽量缩小作用域将会对应用程序的 可靠性产生巨大的影响。

关于常量的命名方法，在JAVA代码中，无论什么时候，均提倡应用常量取代数字、固定字符串。也就是 说，程序中除0，1以外，尽量不应该出现其他数字。常量可以集中在程序开始部分定义或者更宽的作用域内，名字应该都使用大写字母，并且指出该常量完整含 义。如果一个常量名称由多个单词组成，则应该用下划线“\_”来分割这些单词如：NUM\_DAYS\_IN\_WEEK、MAX\_VALUE。

**域(Field)命名**

非公有，非静态字段命名以m开头。  
静态域命名以s开头。  
其他字段以小写字母开头。  
public static final 字段(常量) 全部大写，并用下划线连起来。

**例子：**

1. **public class** MyClass

2. \{

3.  **public static final int** SOME\_CONSTANT = 42;

4.  **public int** publicField;

5.  **private static** MyClass sSingleton;

6.  **int** mPackagePrivate;

7.  **private int** mPrivate;

8.  **protected int** mProtected;

9. \}

**文件命名规范**

res/layout目录下文件：

统一用小写和下划线"\_"组合命名，建议xml文件加个前缀以便区分，如对话框的xml配置文件:dlg\_name.xml；

res/drawable目录下文件：

统一用小写加下划线“\_”组合命名，同上，每个资源文件最好加个前缀以便区分，如：btn\_submit\_default.png，btn\_ submit\_pressed.png，btn\_ submit.xml;

### **三 样式规范** ###

1. [注释/Javadoc ][Javadoc]：使用标准样式写它

2. [简短的方法][Link 1]：不写超大的方法，如果一个方法超过一屏，则考虑重构。

3. 字段(成员变量)：要么是在该文件的顶部，或紧接在使用它们的方法前面。

4. [局部变量][Link 2]：限制作用域

5. [行长度][Link 3]：一行的最大长度是一屏。

6. [一致性][Link 4]：保证代码规范的一致性。

7. 在定义类时，应该按照访问权限的大小分别排列属性和方法。

1、public  
2、protected  
3、包级别(没有访问修饰符的，默认为friendly)  
4、private

8. 单位使用规范。

在使用单位时，如果没有特殊情况，一律采用dip和sp（字体大小单位）这两个单位。因为这两个单位是与设备分辨率无关的，能够解决在不同分辨率的设备上显示效果不同的问题。

**附录：**

Google CodeStyle Guidelines for Contributors [http://source.android.com/source/code-style.html][http_source.android.com_source_code-style.html]

我的工作日志；

1、首先将原来杂乱的class按功能和特性分到不同的package中，暂时将无用的类保存在一个单独的包中。

2、修改package名、class名、变量名及函数名

其中，对于package，参考一个开源代码，将包结构更改

如下：

![1334046217_5918.JPG][]

![http_blog.csdn.net_scy411082514_article_details_7424485][]

其中，最上的包对应软件主界面所用的类，下面为添加功能的类。

class变量及函数名参考上述规则。

[http_blog.csdn.net_scy411082514_article_details_7424485]: /images/20220731/abe00bc6073d45afa3040c6ed8e319e2.png
[Javadoc]: http://blog.lytsing.org/archives/39.html#javadoc
[Link 1]: http://blog.lytsing.org/archives/39.html#shortmethods
[Link 2]: http://blog.lytsing.org/archives/39.html#localvariables
[Link 3]: http://blog.lytsing.org/archives/39.html#linelen
[Link 4]: http://blog.lytsing.org/archives/39.html#consistency
[http_source.android.com_source_code-style.html]: http://source.android.com/source/code-style.html
[1334046217_5918.JPG]: https://img-my.csdn.net/uploads/201204/10/1334046217_5918.JPG