这篇文章主要为大家介绍了在参与开发国际化项目时需遵循的java命名规范,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步
前言
最近笔者帮一些朋友应聘远程工作(一般是一些国外的项目)。国外的项目负责人一般会要求github账号或者一些源代码。很多朋友都是在这个层面被筛选出来的,包括一些业内大牛我觉得都很熟练。他们开发过很多大型项目,经验和技术实力都很不错。这到底是为什么?经过仔细研究,我发现它们都有一个共同点,就是命名标准不严谨。我对这些在申请远程项目第一关就被筛选出来的程序员做了一个问卷调查:你知道哪些java命名约定?最终结果显示:
类的首字母要大写,使用驼峰标识变量首字母小写,使用驼峰标识常量字母全部大写,下划线分隔使用英文单词,不要使用拼音
在很多java程序员看来,做到这一点已经是非常标准的命名方式了。缺点是什么?作者总结了java开发中一些最常用的命名规范。如有不足之处,欢迎不吝赐教!如果你觉得这篇文章对你有帮助,期待你的关注和转发!
一、package命名规范
软件项目的包名应该是你公司域名的逆序,加上你项目的名字,都用小写字母,不能包含其他符号。您可以在末尾添加软件包的版本,如下例所示:
org.example.aprojectnameorg.example.aprojectname.innerpkgorg.example.aprojectname.innerpkg.anotherpkgorg.example.aprojectname.innerpkg2org.example.anotherprojectorg.example.anotherproject.v2
二、Class命名规范
类名必须是名词,由hump命名,首字母要大写,比如HashMap。应该可以从类名中推断出它可能包含哪些函数和变量。例如:
class Student{}class ArrayList{}class HashMap{}class ComputerEngineer{}
三、Interface接口
接口的名称应尽可能使用形容词。有时也可以是名词,如List或Map。与类的命名约定一样,应该使用驼峰名称,并且第一个字母应该大写。如下所示:
interface Cloneable{}interface AutoCloseable{}interface PreparedStatement{}interface Engineer{}
接口通常表示一类对象的通称。形容词ldquo运行rdquo可以是接口名,实现类可以是人、狗、猫。
名词的使用要通用,ldquo爪子rdquoLdquo爪rdquo更像是一个接口的名字。
四、变量
变量应该是简短有意义的名词,以驼峰命名,首字母小写。并且不要使用破折号(# 39;_#39;)或美元符号# 39;$#39;人物。
在for循环中使用的计数变量,可以是i,j,k,m和n,它们也常用于整数对于布尔值,通常开头应该是is或has。可以使用Of串联多个名词可以使用形容词修饰名词int countOfCustomer; //Of串联float averageInterest; //形容词修饰名词long timeInMillisecond, daysInYear; //时间boolean isEngineer, isCompleted, hasSubmitted; //布尔类型
五、常量
常量也是程序的重要组成部分。也要用名词,或者用形容词修饰的名词。所有字母大写,单词用下划线分隔。
public static final float PI = 3.14;static int CREATED_ON_YEAR = 2019;
六、方法
方法的名字要用动词,方法的功能要从名字推断出来,名字要尽量短。以驼峰标志命名。一般get和set分别用来获取数据和设置数据。对于布尔值,方法名应该与变量名相同。
void print(Object obj);void remove(Obejct obj);Object update();int getCountOfCustomer();//gettervoid setCountOfCustomer(int countOfCustomers);//setterboolean isUserAdmin(User user); //布尔类型
七、泛型
使用单个大写字母,T被广泛使用。e通常用于设置元素,K和V通常用于映射关系。不要使用多个字符。
public lt;Tgt; void print(T t);interface Listlt;Egt;{}class HashMaplt;K, Vgt; {};
以上是java开发国际化项目应该遵循的命名规范的详细内容。更多关于java国际化的命名规范
精彩评论