版权声明:转载请标明出处哦 https://blog.csdn.net/easy_purple/article/details/84574119
写了一些代码,越发觉得命名规范对开发有着重要的作用!所以这里根据网上的建议,总结了一些命名规范。下面是整个文章的目录(内容如有哪些不合理,望指出!)
- java命名规范:常用(包、类、接口、方法、变量、常量)参考文章:【点我】
- Android开发命名规范(基于java命名规范):参考文章:【点我】
- 四种编程命名规范(匈牙利命名法、驼峰式命名法、帕斯卡命名法、下划线命名法)参考文章:【点我】
- 强制:略。参考链接:【点我】
java命名规范:常用(包、类、接口、方法、变量、常量)
包(packages): 采用反域名命名规则,全部使用小写字母。一级包名为地顶级域名如com,二级包名为xx(可以是公司或则个人的随便),三级包名根据应用进行命名,四级包名为模块名或层级名; 如
- com.tinyx.myapp.activities;
类(Classes) 命名规则:类名是个一名词,采用大小写混合的方式,每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词,避免缩写词(除非该缩写词被更广泛使用,像URL,HTML)
- class Raster
- class ImageSprite
接口(Interfaces) 命名规则:大小写规则与类名相似 interface RasterDelegate;
- interface RasterDelegate;
- interface Storing;
方法 (Methods) 方法名是一个动词,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。
- run()
- runFast()
- getBackground()
变量(Variables) 除了变量名外,所有实例,包括类,类常量,均采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。变量名不应以下划线或美元符号开头,尽管这在语法上是允许的。
变量名应简短且富于描述。变量名的选用应该易于记忆,即,能够指出其用途。尽量避免单个字符的变量名,除非是一次性的临时变量。临时变量通常被取名为i,j,k,m和n,它们一般用于整型;c,d,e,它们一般用于字符型。
- int i
- char c
- float myWidth
常量(Constants) 类常量和ANSI常量的声明,应该全部大写,单词间用下划线隔开。(尽量避免ANSI常量,容易引起错误)
- static final int MIN_WIDTH = 4;
- static final int MAX_WIDTH = 999;
- static final int GET_THE_CPU = 1;
Android开发命名规范(基于java命名规范)
包名
- 第一维度使用模块,第二维度是功能
- 包名一般要求小写,并且尽量不出现下划线等字符,值得注意的是,需要用英文来命名而不是中文。例如views,widge
- 一般是功能、模块的简写,能够让包名能够一目了然,知道这个包里面放的是什么文件。例如ui、activity等
类名(要求对类进行注释!!!)
- java类的命名首字母要求大写,采取驼峰式命名
- java类的命名要尽量一目了然,闻其名而知其意
- 如果是一般的接口(interface)文件,则命名为Ixxx.java,
- 如果是监听文件的,一般是以On开头,例如:OnGetCityDataListener.java
java变量、方法等的命名(并且尽可能的给函数方法进行注释说明)
- 设置全局变量和静态变量以m、s开头
资源文件命名规范的重要性
- 资源文件命名以小写字母+下划线组成,名字不怕长就怕太简略,要尽可能一眼能看出该资源文件是用来干什么的,我改怎么去找到这个文件?鉴于Android开发肯定会存在很多很多的资源,所以最好能够一个一个模块的放好、并且有明显的命名去命名,方便自己也方便他人在二次开发、bug修复和后续迭代等操作中能够更快的定位到。这个步骤很繁琐,要做好不简单,见微知著,细心耐心!
四种编程命名规范
匈牙利命名:开头字母用变量类型的缩写,其余部分用变量的英文或英文的缩写,要求单词第一个字母大写。
- int iMyAge; “i”是int类型的缩写;
- char cMyName[10]; “c”是char类型的缩写;
- float fManHeight; “f”是float类型的缩写;
- 更多
驼峰式命名法:(又叫小驼峰式命名法)第一个单词首字母小写,后面其他单词首字母大写。
- int myAge;
- char myName[10];
- float manHeight;
帕斯卡命名(又叫大驼峰式命名法)每个单词的第一个字母都大写。
- int MyAge;
- char MyName[10];
- float ManHeight;
下划线命名法单词与单词间用下划线做间隔
- foo_bar